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

Update README.md #400

Merged
merged 4 commits into from
Feb 22, 2023
Merged

Update README.md #400

merged 4 commits into from
Feb 22, 2023

Conversation

sssoleileraaa
Copy link
Contributor

@sssoleileraaa sssoleileraaa commented Nov 1, 2022

Status

Closes #304

Description of Changes

  • Updated references to the old securedrop-builder name (I can't even remember it, it's so old ;))
  • Since the workstation release management docs were difficult to read and scattered, I did some consolidation work to move release-specific instructions to Consolidate and update workstation release management process securedrop-dev-docs#30, which should be reviewed in tandem with this PR.
  • Removed outdated Python build instructions and generalized how to use our build tool

Checklist

@gonzalo-bulnes
Copy link
Contributor

The changes so far are looking great!

@sssoleileraaa
Copy link
Contributor Author

@gonzalo-bulnes - I spent some time separating release management from generic instructions on how to use this tool. So this PR should be reviewed in tandem with an incoming securedrop-dev-docs PR (it'll be in draft because I'll need to edit it for formatting and style still).

@sssoleileraaa
Copy link
Contributor Author

TODO: Once freedomofpress/securedrop-dev-docs#30 is merged, link to the section on how to build a dispVM rather than duplicating the instructions here, see https://github.com/freedomofpress/securedrop-dev-docs/pull/30/files#r1035458154

@sssoleileraaa
Copy link
Contributor Author

sssoleileraaa commented Feb 14, 2023

[Blocked on https://github.com/freedomofpress/infrastructure/pull/4068 + tandem PR for securedrop repos + actually renaming the repos]


UPDATE: this is done

@sssoleileraaa
Copy link
Contributor Author

sssoleileraaa commented Feb 22, 2023

@gonzalo-bulnes, if you end up merging freedomofpress/securedrop-dev-docs#30, this is the next PR to review, which references a section added in freedomofpress/securedrop-dev-docs#30 (see checklist in the PR description).

Comment on lines 3 to 4
[![CircleCI](https://circleci.com/gh/freedomofpress/securedrop-builder/tree/main.svg?style=svg)](https://circleci.com/gh/freedomofpress/securedrop-builder/tree/main)

Copy link
Contributor

Choose a reason for hiding this comment

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

Is putting the badge above the main header intentional? (I notice it doesn't show up in the preview.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

:/ I see it still when I "view file": https://github.com/freedomofpress/securedrop-builder/blob/1f5feba3f9176b17e16084bb7c0877dcd98560bc/README

The badge is intentionally there and this PR shouldn't remove it.

@gonzalo-bulnes
Copy link
Contributor

Only waiting for freedomofpress/securedrop-dev-docs#30 🙂

@gonzalo-bulnes
Copy link
Contributor

@creviera I see only Bookworm jobs are failing in CI, and FWIW I wouldn't block this PR on them.

@sssoleileraaa
Copy link
Contributor Author

@gonzalo-bulnes, while addressing your reviews, I noticed another opportunity to further consolidate our documentation. For deployment, the readme now points to the docs in freedomofpress/securedrop-dev-docs#30, so you'll notice that last commit that I pushed is mostly just deleting stuff: ba2c611

Copy link
Contributor

@gonzalo-bulnes gonzalo-bulnes left a comment

Choose a reason for hiding this comment

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

@gonzalo-bulnes gonzalo-bulnes merged commit a294b66 into main Feb 22, 2023
@gonzalo-bulnes gonzalo-bulnes deleted the creviera-readme-update branch February 22, 2023 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename some packaging-related repos
3 participants