This repository has been archived by the owner on Aug 1, 2024. It is now read-only.
docs: More troubleshooting tips (starting from scratch; broken outline) #1141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(I've cancelled the provisioning tests for this doc-only PR.) |
robrap
reviewed
Aug 1, 2023
docs/troubleshoot_general_tips.rst
Outdated
| @@ -218,7 +218,7 @@ Another error you may get if the code and the image are out of sync is sql or Dj | |||
|
|
|||
| Demo course is empty in studio | |||
| ------------------------------ | |||
| After provisioning and opening Studio, you may see an empty outline for the demo course. This usually means there is a disconnect between the block ids in mySQL and the corresponding data in Mongo. | |||
| After provisioning and opening Studio, you may see an empty outline for the demo course. This usually means there is a disconnect between the block ids in mySQL and the corresponding data in Mongo. See https://github.com/openedx/devstack/issues/1073 for the tracking issue. | |||
There was a problem hiding this comment.
- I'd move this to a new line after 223 (that details the fix).
- In 223, consider updating to "To fix locally...", or any other language that notes that this is a workaround fix.
- Consider adding something to clarify the point of the issue you are point to, for example, if it is the issue for a more permanent fix that would avoid this workaround?
There was a problem hiding this comment.
Adjusted this section.
docs/troubleshoot_general_tips.rst
Outdated
| Starting From Scratch | ||
| ===================== | ||
|
|
||
| If you think your devstack is broken beyond repair, you can start from scratch using ``make dev.destroy``, followed by the Getting Started instructions. |
There was a problem hiding this comment.
Nit: link to Getting Started instructions?
There was a problem hiding this comment.
I will admit I thought of this but then didn't want to figure out the exact rST syntax required. 🙃
docs/troubleshoot_general_tips.rst
Outdated
|
|
||
| If you think your devstack is broken beyond repair, you can start from scratch using ``make dev.destroy``, followed by the Getting Started instructions. | ||
|
|
||
| If you want to make absolutely sure that there are no lingering data volumes after the ``dev.destroy`` step, run ``docker volume ls --quiet | grep devstack`` -- if you see surviving devstack volumes that are currently mentioned in docker-compose.yml, there may be a bug. |
There was a problem hiding this comment.
Can you clarify what "there may be a bug" means, and what someone should do?
There was a problem hiding this comment.
I left it vague on purpose. My main goal was to convey "if you see this, something may be abnormal". I'm reticent to encourage people to submit bug reports that are lacking information, but also don't want to overwhelm the section with anything too specific. Suggestions on phrasing? Maybe something like this:
Suggested change
| If you want to make absolutely sure that there are no lingering data volumes after the ``dev.destroy`` step, run ``docker volume ls --quiet | grep devstack`` -- if you see surviving devstack volumes that are currently mentioned in docker-compose.yml, there may be a bug. | |
| If you want to make absolutely sure that there are no lingering data volumes after the ``dev.destroy`` step, run ``docker volume ls --quiet | grep devstack`` -- if you see surviving devstack volumes that are currently mentioned in docker-compose.yml, there may be a bug. If you can reproduce the issue reliably, consider `reporting an issue <Reporting New Issues_>`_. |
(except that links to the next section, so it's actually very confusing to click that link...)
robrap
approved these changes
Aug 2, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've completed each of the following or determined they are not applicable: