Document how to resolve noble pre-migration issues #612
Conversation
|
This is my first stab at docs - not perfect but ready for feedback/review. |
There was a problem hiding this comment.
Thanks @legoktm, this is a great start! Left a few nit-picky comments and suggestions in-line; will take another pass once those are looked after, and the pending output text has been added.
* Explicitly flag which messages are error conditions; otherwise it would be hard to tell whether "group is empty" or "group is not empty" is the problematic state. * Add a newline before our closing help message. * Link to docs that explain how to resolve these issues (still pending review at <freedomofpress/securedrop-docs#612>).
|
|
||
| .. code:: sh | ||
|
|
||
| $ sudo securedrop-noble-migration-check |
There was a problem hiding this comment.
This output is based on the changes I've proposed in freedomofpress/securedrop#7369.
|
Per discussion in today's standup, I've added a "Timeline" section, telling admins to resolve the issues by Jan 31, 2025. |
There was a problem hiding this comment.
Going to go ahead and approve. I left one comment about a line that is arguably confusing, but if others feel it serves a purpose, it's OK to leave in.
Going to hold off on merging until freedomofpress/securedrop#7369 officially lands, in case of any last-minute changes there.
legoktm
force-pushed
the
noble-check
branch
2 times, most recently
from
9a531b3 to
5a5da1d
Compare
There was a problem hiding this comment.
Everything looks great now! Approving, holding off on merge until freedomofpress/securedrop#7369 lands.
* Explicitly flag which messages are error conditions; otherwise it would be hard to tell whether "group is empty" or "group is not empty" is the problematic state. * Do the same for success messages by adding "OK" to them. * Add a newline before our closing help message. * Link to docs that explain how to resolve these issues (still pending review at <freedomofpress/securedrop-docs#612>).
Give a basic overview on the upcoming noble migration and provide specifics on what each issue category means and how to resolve each one, including debugging information to send to support if unsuccessful. Fixes #610.
* Explicitly flag which messages are error conditions; otherwise it would be hard to tell whether "group is empty" or "group is not empty" is the problematic state. * Do the same for success messages by adding "OK" to them. * Add a newline before our closing help message. * Link to docs that explain how to resolve these issues (still pending review at <freedomofpress/securedrop-docs#612>). (cherry picked from commit 4d77a7c)
* Explicitly flag which messages are error conditions; otherwise it would be hard to tell whether "group is empty" or "group is not empty" is the problematic state. * Do the same for success messages by adding "OK" to them. * Add a newline before our closing help message. * Link to docs that explain how to resolve these issues (still pending review at <freedomofpress/securedrop-docs#612>). (cherry picked from commit 4d77a7c)
|
OK, this should be ready to go now. There was one more change in format (adding "OK" to the checks that pass), which I've updated this PR for. |
There was a problem hiding this comment.
Approving based on @nathandyer's review in #612 (review), after which I confirm https://github.com/freedomofpress/securedrop-docs/compare/5a5da1d02ddaf2b7418b5cf563d6a08665fdfcc6..b9604d5e61fe5de80a10efc76f615bf7bae94d50 indeed contains only the changes I requested in freedomofpress/securedrop#7369 (review).
Status
Ready for review
Description of Changes
Give a basic overview on the upcoming noble migration and provide specifics on what each issue category means and how to resolve each one, including debugging information to send to support if unsuccessful.
Testing
Release
Checklist (Optional)
make docs-lint) passed locallymake docs-linkcheck) passedmake docs) docs at http://localhost:8000