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

Removes Xenial-specific references from the docs #214

Merged
merged 1 commit into from May 5, 2021
Merged

Conversation

conorsch
Copy link
Contributor

@conorsch conorsch commented May 4, 2021

Status

Ready for review

Description of Changes

Follow-up to freedomofpress/securedrop#5911,
in which we removed Xenial-specific codepaths from the code repo.
Here, we do the same throughout the documentation. There are notable
exceptions:

Those URLs remain untouched by these changes. We can follow up soon with
removal for those, too, but it seems helpful to maintain a bit longer.

Testing

  1. Check for any missed references to the old OS. Try grep -ri xenial and grep -r 16.04, for instance.
  2. Do you agree we should preserve the v3 services & focal migration docs for now?

Release

Intentionally deferring a few docs changes (see above), to preserve URLs a while longer. If folks find that too conservative, happy to remove in this PR.

Checklist (Optional)

  • Doc linting (make docs-lint) passed locally
  • Doc link linting (make docs-linkcheck) passed
  • You have previewed (make docs) docs at http://localhost:8000

- **Focal:** use the command ``make build-debs-focal``
.. code:: sh

make build-debs-focal
Copy link
Member

@eloquence eloquence May 4, 2021

Choose a reason for hiding this comment

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

That Makefile target does not exist, it's just build-debs now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, fixed!

Follow-up to freedomofpress/securedrop#5911,
in which we removed Xenial-specific codepaths from the code repo.
Here, we do the same throughout the documentation. There are notable
exceptions:

  * https://docs.securedrop.org/en/stable/v3_services.html
  * https://docs.securedrop.org/en/stable/upgrade/focal_migration.html

Those URLs remain untouched by these changes. We can follow up soon with
removal for those, too, but it seems helpful to maintain a bit longer.

sudo cron-apt -i -s


Copy link
Member

Choose a reason for hiding this comment

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

I think by 2.10 or 2.2.0 we can remove the OS platform check here from the docs entirely, but fine to keep for now to avoid any confusion.

--- a/devops/gce-nested/ci-go.sh
+++ b/devops/gce-nested/ci-go.sh
@@ -16,4 +16,3 @@ export BASE_OS="${BASE_OS:-xenial}"
diff --git a/.circleci/config.yml b/.circleci/config.yml
Copy link
Member

Choose a reason for hiding this comment

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

Tested that diff applies cleanly on current develop. A bit iffy to maintain this way in docs though, maybe we can script that in future?

Copy link
Member

@eloquence eloquence left a comment

Choose a reason for hiding this comment

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

Check for any missed references to the old OS. Try grep -ri xenial and grep -r 16.04, for instance.

All LGTM there!

Do you agree we should preserve the v3 services & focal migration docs for now?

I think we can ditch the v3 docs soon, but that's tracked in #213.

@eloquence eloquence merged commit dc1e198 into main May 5, 2021
SecureDrop Team Board automation moved this from Under Review to Done May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants