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

Add initial build system, based on securedrop-workstation-docs #2

Merged
merged 2 commits into from
Sep 21, 2020

Conversation

eloquence
Copy link
Member

@eloquence eloquence commented Sep 19, 2020

Adds a preliminary build system for this repo, based on the securedrop-workstation-docs logic and the previous configuration. Does not include docs-linkcheck job yet. Installs latest git-lfs release when operating in RTD context per docs at https://test-builds.readthedocs.io/en/git-lfs/ (if this is not done, we'll get build failures as can be seen in https://readthedocs.org/projects/securedrop-docs/builds/11915945/).

Status

Ready for review

Test plan

Build the docs by following the instructions provided in the README in this PR.

@eloquence eloquence force-pushed the build-back-better branch 2 times, most recently from ccb03a0 to 712d2b5 Compare September 19, 2020 01:11
@eloquence
Copy link
Member Author

eloquence commented Sep 19, 2020

https://securedrop-docs.readthedocs.io/ is currently configured to build from this branch, and is working as expected. 🎉 The LFS installation logic added in this PR is indeed required for it to work. Once this PR lands, we can configure RTD to point to main, and set up the tags for the stable version.

@eloquence eloquence marked this pull request as ready for review September 19, 2020 01:22
@zenmonkeykstop zenmonkeykstop self-assigned this Sep 21, 2020
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

Build instructions in README.md works as expected. Documents look consistent with current version based on a few spot-checks and docs-lint make target passing.

LGTM!

@zenmonkeykstop zenmonkeykstop merged commit adea6a4 into main Sep 21, 2020
@zenmonkeykstop zenmonkeykstop deleted the build-back-better branch September 21, 2020 23:22
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.

None yet

2 participants