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.

Sign up for GitHub

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

Jump to bottom

[DOC] - Nebari getting started follow-up items #88

Closed
trallard opened this issue Jul 4, 2022 · 6 comments
Closed

[DOC] - Nebari getting started follow-up items #88

trallard opened this issue Jul 4, 2022 · 6 comments
Assignees
@viniciusdc
Labels
area: accessibility ♿️ Accessibility related features or issues area: documentation 📖 content: doc/how-to Diatiaxis - how to type: enhancement 💅🏼 New feature or request

Comments

@trallard
Copy link
Member

trallard commented Jul 4, 2022

Changes required, that will be addressed in separate issues:

  • Add links to the advanced-setting section, ref.
  • Mention project naming conventions
  • Add Alt text and mouse over text to images, ref.
  • Link to Keycloak docs for root management?, ref.
  • Add troubleshooting question for Can't find my KUBECONFIG_FILE on /temp, what should I do? ? ref.
  • Add more clinical presentation of the features present/absent in each cloud provider option, ref.
  • Need to add a link here to the 'base costs' section of the docs. ref.
  • Need to add docs regarding local and pre-existing Kubernetes installation options, why use them, and what`s the difference? ref.

Originally posted by @viniciusdc in nebari-dev/nebari#45 (comment)
@trallard trallard added type: enhancement 💅🏼 New feature or request area: documentation 📖 area: accessibility ♿️ Accessibility related features or issues content: doc/how-to Diatiaxis - how to labels Jul 4, 2022
@trallard
Copy link
Member Author

trallard commented Jul 28, 2022 •
edited by kcpevey
Loading

@kcpevey
Copy link
Contributor

kcpevey commented Aug 3, 2022 •
edited by viniciusdc
Loading

magsol added a commit that referenced this issue Aug 4, 2022
@magsol
Initial attempt at addressing the NEBARI_KUBECONFIG in tmp issue rais…
2f8dc96 
…ed in #83 and #88. May need some more detail.
@viniciusdc
Copy link
Contributor

Working on this, will open a PR for discussion later today

This was referenced Aug 11, 2022
Closed
Merged
kcpevey pushed a commit that referenced this issue Aug 23, 2022
@magsol
[DOC] Nebari Troubleshooting page (#97)
0cef299 
* Initial draft of the Troubleshooting page.

* Added (and edited) existing troubleshooting docs, formatted according to the helpful JupyterHub categorical format.

* Added content from the old QHub Admin Guide FAQ.

* Initial attempt at addressing the NEBARI_KUBECONFIG in tmp issue raised in #83 and #88. May need some more detail.

* Troubleshooting section is almost complete, except for the ML environments piece as well as explicitly identifying parts of the doc that will definitely be out of date when it launches.

* Initial docs complete. Now need to 1) specify parts of the doc that will require updates, and 2) check on failing tests.

* Removed broken doc hyperlinks.

* Removed a few additional references to qhub.

* Somehow missed this suggestion.

* Addressed all the grammar/syntax fixes, working on closing out the discussions.

* Resolved a few more discussion items.

* Fixed arbitrary pod answer.

* Converted table to tabs.

* Embarrassing spelling error, fixed.

* Updated format to mdx to enable tabbed content.

* Removed broken links.

* Added some context to some of the questions that needed it, including the why/what/how around each.

* Fixed sidebar link.

* Applied fix for #134.
@trallard
Copy link
Member Author

What is the status of this and the subtasks @kcpevey and @viniciusdc ?

@kcpevey
Copy link
Contributor

kcpevey commented Mar 22, 2023

@trallard I've updated the checkbox list above - added links to the open PRs and confirmed the status of each

@pavithraes
Copy link
Member

This issue has been open for a while, so I'll close and prioritize the individually scoped issues separately. Please feel free to re-open if there is a need. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@viniciusdc viniciusdc

Labels
area: accessibility ♿️ Accessibility related features or issues area: documentation 📖 content: doc/how-to Diatiaxis - how to type: enhancement 💅🏼 New feature or request
Projects
📖 - Documentation
Status: Done 💪🏾
🪴 Nebari Project Management
Archived in project
🗃 - Nebari backlog
Status: Done 💪🏾
Milestone
No milestone
Development

No branches or pull requests
4 participants
@kcpevey @trallard @pavithraes @viniciusdc