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] Add troubleshooting docs #1139

Merged
merged 16 commits into from
Mar 3, 2022
Merged

[DOC] Add troubleshooting docs #1139

merged 16 commits into from
Mar 3, 2022

Conversation

iameskild
Copy link
Member

Fixes | Closes | Resolves #1036

References #1032, #1076, #1009

Please remove anything marked as optional that you don't need to fill in.
Choose one of the keywords preceding to refer to the issue this PR solves, followed by the issue number (e.g Fixes # 666).
If there is no issue, remove the line. Remove this note after reading.

Changes introduced in this PR:

  • Add troubleshooting doc which outlines two common issues we've experienced when testing v0.4.0 release.
    • "DNS domain=your_qhub_domain record does not exist"
    • A Conda-Store environment fails to build

Types of changes

What types of changes does your PR introduce?

Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features to not work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

Requires testing

  • Yes
  • No

In case you checked yes, did you write tests?

  • Yes
  • No

Documentation

Does your contribution include breaking changes or deprecations?
If so have you updated the documentation?

  • Yes, docstrings
  • Yes, main documentation
  • Yes, deprecation notices

Further comments (optional)

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered and more.

@iameskild iameskild requested review from trallard and costrouc March 3, 2022 09:10
@trallard trallard added needs: review 👀 This PR is complete and ready for reviewing area: documentation 📖 Improvements or additions to documentation labels Mar 3, 2022
Copy link
Member

@trallard trallard left a comment

Choose a reason for hiding this comment

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

Overall looks good - as usual, left some comments and suggestions - also pushed some minor changes so make sure to pull before making any local changes

docs/source/installation/login.md Outdated Show resolved Hide resolved
docs/source/installation/login.md Outdated Show resolved Hide resolved
docs/source/installation/login.md Outdated Show resolved Hide resolved
docs/source/installation/login.md Outdated Show resolved Hide resolved
docs/source/installation/login.md Outdated Show resolved Hide resolved
docs/source/user_guide/troubleshooting.md Outdated Show resolved Hide resolved
docs/source/user_guide/troubleshooting.md Outdated Show resolved Hide resolved
docs/source/user_guide/troubleshooting.md Outdated Show resolved Hide resolved
docs/source/user_guide/troubleshooting.md Show resolved Hide resolved
docs/source/user_guide/troubleshooting.md Outdated Show resolved Hide resolved
@trallard trallard added needs: changes 🧱 Review completed - some changes are needed before merging and removed needs: review 👀 This PR is complete and ready for reviewing labels Mar 3, 2022
iameskild and others added 11 commits March 3, 2022 15:51
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
@iameskild iameskild added needs: review 👀 This PR is complete and ready for reviewing and removed needs: changes 🧱 Review completed - some changes are needed before merging labels Mar 3, 2022
@iameskild
Copy link
Member Author

Hey @trallard, thanks for the thorough review again. I believe it's ready for a final review :)

@iameskild iameskild added this to the Release v0.4.0 milestone Mar 3, 2022
Copy link
Member

@costrouc costrouc left a comment

Choose a reason for hiding this comment

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

@iameskild thanks for this work. Looks great to me. I appreciate the format of the troubleshooting docs and think it makes a great template for us to use going forward for issues we are aware of but can't solve immediately.

@costrouc costrouc merged commit 62196c9 into main Mar 3, 2022
@costrouc costrouc deleted the docs_troubleshooting_eae branch March 3, 2022 19:48
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 needs: review 👀 This PR is complete and ready for reviewing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[documentation] Documentation on conda environments failing to build on first try
3 participants