add(doc): Add draft audit process, and update some support docs #5433
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teor2345
added
A-docs
upbqdn
approved these changes
Oct 20, 2022
oxarbitrage
added a commit
that referenced
this pull request
Oct 31, 2022
the version in the book install.md was removed in #5433
33 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Let's document the audit decisions we've taken so far, we can update them later if they change.
This PR also makes some minor support documentation fixes.
Close #5431.
Solution
The audit doc is based on meetings, slack conversations, ticket #5214, and PR #5395.
The release process changes fix an incorrect render on
main, and make the document consistent with our other markdown docs.The download workaround addresses a bug report in the #zebra discord channel.
The build doc changes replace an outdated build process with a link to the latest documentation in the README.
Review
Anyone can review this PR, but @gustavovalverde opened the audit ticket.
Reviewer Checklist
Follow Up Work
Edit this document if the audit process changes significantly.