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

Create a FAQ and "common user problems" section in our documentation #130

Open
choldgraf opened this issue Mar 18, 2022 · 2 comments
Open

Comments

@choldgraf
Copy link
Member

Background and proposal

There are some cases where users will run into common issues in the hub. These might not be fixable in the long-term, and will need some kind of user action each time it is encountered.

Instead of having a one-on-one support conversation every time, we could try to document the more common of these for others to reference.

Examples of this issue:

  • Websockets browser issue - in this discourse post the user reported some strange behavior where the UI seemed to work but was unresponsive. We decided this was likely a websockets issue, and there might be some specific things to try in order to fix it.
  • Random .nsf*** files being generated - in this support ticket we had a report that random .nsf*** files were being created. It seems this is because of some weird NFS behavior and the short-term fix was to add .nfs* to the .gitignore file.

In both cases, it didn't seem like a fix could be applied at the cloud infrastructure level, so some docs could have helped guide the person forward.

Implementation guide and constraints

I think there are three potential ways of documenting this kind of thing:

  1. **A dedicated "Common problems" or a "Troubleshooting tips" section as a top-level section in the user docs.
  2. Dedicated subsections under each topic for this kind of thing (e.g. a section under "Authentication" could be called "Common problems").
  3. Using a different space for more free-form Q&A style content. For example, Discourse forums often serve this purpose, so that users can search through forum results for similar questions.

Updates and ongoing work

No response

@damianavila
Copy link
Contributor

I would start with step 1 and see if that works/helps.
I am worried that if we start a Discourse right now, we will not have the resources to keep an eye on it...

@jmunroe jmunroe changed the title Create a "common user problems" section in our documentation Create a FAQ and "common user problems" section in our documentation Nov 1, 2022
@jmunroe
Copy link
Contributor

jmunroe commented Nov 1, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants