-
Notifications
You must be signed in to change notification settings - Fork 687
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
Remove docs, update CI config & tooling #5520
Conversation
af737f6
to
d8a5eb6
Compare
Pending CI results, I believe this is ready for formal review now, but keeping in draft mode until the new docs repo is live at https://docs.securedrop.org/ To wrap up the migration, we'll need to also update contributor guidelines and release management docs; Joan and I will tackle that next over in the securedrop-docs repo. |
4d35115
to
efc02e7
Compare
Took an initial pass through, in conjunction with freedomofpress/securedrop-docs#8
Testing locally, I see
Which doesn't appear to be a problem with this PR, but one we need to resolve all the same. Blame suggests #5465 broke it, which I merged. Mea culpa! Since 1.6.0~rc1 was already configured in develop, we didn't catch this when branching to
For both scripts, it seems reasonable to me to set a default value of "../securedrop-docs" and not complain if that dir is found, but we needn't do that on day one. Most important, running the scripts without any customizations makes it very obvious how to resolve, which is a pleasant experience. |
I was hesitant to that because copying a large number of files or making commits beyond the context of a single repo seemed to me the kind of operation a user should always explicitly parametrize to avoid surprises, but I'm happy to go with whatever the team consensus is on this one. |
efc02e7
to
9eb1013
Compare
Remove docs* and stable branch rules Towards #5435
A new pip-compile run bumps the six dependency, as well.
- Add docs repo support to i18n_tool.py - Migrate docs edits out of update_version.sh - Add support for docs repo to update-user-guides target. The script is run inside a container that does not have access to the repo checkout, so moved the copy logic into the Makefile. Renamed script to accurately reflect its revised purpose.
9eb1013
to
0676647
Compare
https://docs.securedrop.org/ is now built from https://github.com/freedomofpress/securedrop-docs , so promoting this to ready. Squashed into three distinct commits. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Observe that
./update_version.sh
still operates as expected while no longer attempting to modify documentation. - Observe that
python3 securedrop/i18n_tool.py update-docs
(updates list of languages) is self-documenting and works as expected in combination with a docs repo checkout. Easiest to test by removing a valid language fromdocs/includes/l10n.txt
in the docs repo checkout via a test commit. - Observe that
make update-user-guides
is self-documenting and works in combination with a docs repo checkout.
Works great! The scripts are quite helpful when run without the required arguments. During 1.6 release, will watch for opportunities to improve further if any surprises occur.
Proceeding with merge into |
Docs removal and tooling changes in support of standalone docs repo. Blocked until https://docs.securedrop.org/ is switched over.
Further towards #5435.
Description
docs*
andstable
branches) and docs version update logic (cf. Add basic version update script securedrop-docs#6).update_version.sh
(see Add basic version update script securedrop-docs#6).i18n_tool.py
to require a repo directory when updating the list of languages.update-user-guides
target to support aDOCS_REPO_DIR
environment variable.Note to reviewer
Test plan
./update_version.sh
still operates as expected while no longer attempting to modify documentation.python3 securedrop/i18n_tool.py update-docs
(updates list of languages) is self-documenting and works as expected in combination with a docs repo checkout. Easiest to test by removing a valid language fromdocs/includes/l10n.txt
in the docs repo checkout via a test commit.make update-user-guides
is self-documenting and works in combination with a docs repo checkout.