Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: more explicitly request information in helpdesk message #154

Merged
merged 5 commits into from
Nov 28, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions src/discord/help-desk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -313,13 +313,13 @@ export class DiscordHelpDesk {
`I have reviewed the [FAQs](${Constants.Urls.Docs.FAQ}) for known issues.`,
`I have reviewed [Github](${Constants.Urls.Issues}) for known issues.`,
'I have tried accessing Immich via local ip (without a custom reverse proxy).',
'I have uploaded the relevant logs, docker compose, and .env files, making sure to use code formatting.',
'I have uploaded the relevant information (see below).',
'I have tried an incognito window, disabled extensions, cleared mobile app cache, logged out and back in, different browsers, etc. as applicable',
];

return `:wave: Hey <@${user}>,

Thanks for reaching out to us. Please follow the recommended actions below; this will help us be more effective in our support effort and leave more time for building Immich ${Constants.Icons.Immich}.
Thanks for reaching out to us. Please carefully read this message and follow the recommended actions. This will help us be more effective in our support effort and leave more time for building Immich ${Constants.Icons.Immich}.
## References
- __Container Logs:__ \`docker compose logs\` [docs](${Constants.Urls.Docs.Logs})
- __Container Status__: \`docker compose ps\` [docs](${Constants.Urls.Docs.Containers})
Expand All @@ -330,6 +330,20 @@ ${tasks.map((task, index) => `${index + 1}. ${icon(index)} ${task}`).join('\n')}

(an item can be marked as "complete" by reacting with the appropriate number)

## Information

In order to be able to effectively help you, we need you to provide clear information to show what the problem is. The exact details needed vary per case, but here is a list of things to consider:
- Your docker-compose.yml and .env files.
- Logs from all the containers.
- The status of the containers (\`docker ps -a\`).
- Any recent changes you've made to Immich or your system.
- Details about your system (both software/OS and hardware).
- Details about your storage (filesystems, type of disks, output of commands like \`fdisk -l\` and \`df -h\`).
- Any other information that you think might be relevant.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions for more entries are welcome


Please paste files and logs with proper code formatting (three backticks \`\`\`), and especially avoid blurry screenshots.
bo0tzz marked this conversation as resolved.
Show resolved Hide resolved
We're not in your computer, so without the right information we can't work out what the problem is. Help us help you ;)
bo0tzz marked this conversation as resolved.
Show resolved Hide resolved

If this ticket can be closed you can use the \`/close\` command, and re-open it later if needed.`;
}
}
Loading