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

Troubleshooting section (start with devs, mainly with upgrade paths) #1032

Closed
Tracked by #1009
trallard opened this issue Feb 5, 2022 · 3 comments
Closed
Tracked by #1009
Labels
area: documentation 📖 Improvements or additions to documentation impact: high 🟥 This issue affects most of the nebari users or is a critical issue

Comments

@trallard
Copy link
Member

trallard commented Feb 5, 2022

Important especially with the new release and all the changes coming:

  • some common providers/integrations gotchas and how to fix them

Proposed approach:

  1. Issue
  2. Reason for the observed behaviour
  3. Troubleshooting
  4. Optional - resources
@trallard trallard added impact: high 🟥 This issue affects most of the nebari users or is a critical issue area: documentation 📖 Improvements or additions to documentation labels Feb 5, 2022
@trallard trallard added this to the Release v0.4.0 milestone Feb 5, 2022
@costrouc
Copy link
Member

@trallard I think this is a large amount of work and hard to define what done is. We have several docs on gcp issues and how to get kubernetes credentials to check on the cluster.

Are you just suggesting that we have a troubleshooting page?

@trallard
Copy link
Member Author

Are you just suggesting that we have a troubleshooting page?

Indeed - writing in-depth guides for all the providers is a great effort. What I am thinking is something similar to JupyterHub's troubleshooting page https://jupyterhub.readthedocs.io/en/stable/troubleshooting.html which are known pain points / commonly seen issues for the project.

@iameskild iameskild removed this from the Release v0.4.0 milestone Mar 30, 2022
@iameskild
Copy link
Member

Hey @trallard how do you feel if we closed this issue? We now have the troubleshooting section and I agree that we should be adding to it as new "gotchas" are discovered.

@trallard trallard closed this as completed Jun 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation impact: high 🟥 This issue affects most of the nebari users or is a critical issue
Projects
None yet
Development

No branches or pull requests

3 participants