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

[DOC] - Missing information regarding qhub destroy #1298

Closed
viniciusdc opened this issue May 23, 2022 · 3 comments
Closed

[DOC] - Missing information regarding qhub destroy #1298

viniciusdc opened this issue May 23, 2022 · 3 comments
Assignees
Labels
area: documentation 📖 Improvements or additions to documentation area: user experience 👩🏻‍💻 good first issue Good for newcomers

Comments

@viniciusdc
Copy link
Contributor

We are currently lacking background information related to the qhub destroy command and its functionality in the docs.

The only direct mention of the command and its rough behavior is presented in the Minukube section for the development guide, which does not give the user good information on how the command works or what resources if affects.

  • So we should start by adding a new section on the User guide page (or admin?), called cleanup (to follow the standard) commenting on how to execute the command and which resources it will target for each cloud provider;
  • How State files might affect destroy/redeploy behaviours;
  • We might as well, explain how the stages + terraform works on deleting such resources. Also queep in mind that, writing this down could as well affect previous versions of Qhub v0.3.+, trying to get backward compatible documentation would be ideal.

Also, its worth mentioning that even though some "resources" might still exist after deletion, this should be considered an "Exceptional" situation which, if needed, can be covered in a FAQ section -- "" How to manually delete the lingering resource or destroy a Qhub deployment? ""

@viniciusdc viniciusdc changed the title [DOC] - Missing information reggarding qhub destroy [DOC] - Missing information regarding qhub destroy May 23, 2022
@viniciusdc viniciusdc added the good first issue Good for newcomers label May 23, 2022
@HarshCasper HarshCasper self-assigned this May 24, 2022
@trallard
Copy link
Member

trallard commented Jun 1, 2022

Please x-validate against the documentation plan

@viniciusdc
Copy link
Contributor Author

Please x-validate against the documentation plan

Hi @trallard, just updated the plan, thanks for pointing it out 🙂

@trallard
Copy link
Member

trallard commented Jun 7, 2022

Thanks @viniciusdc - closing as I have moved to Nebari and will be superseded there

@trallard trallard closed this as completed Jun 7, 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 area: user experience 👩🏻‍💻 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants