Add documentation for the Checkbox Edge validation process (Infra) #755
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
|
Looks like the mermaid diagrams need to be opted out from the spellcheck. |
pieqq
requested changes
Nov 8, 2023
There was a problem hiding this comment.
Thanks for this detailed explanation!
A few comments here, and others inline:
- The new pages are put in the How To section of the documentation, but I think they would be better in the Reference section, because they are not really step-by-step instructions you can follow to achieve something: it's a process that's already in place, and that you explain (theoretical knowledge that serves our work)
- There is no proper introduction to the whole thing, so it's very hard for anyone who's not from the team to understand what is “Canary Testing for Checkbox Edge Version”.
Both make spelling and make linkcheck complain.
kissiel
force-pushed
the
add-canary-docs
branch
from
ec464ef
to
f240504
Compare
yphus
previously requested changes
Jan 8, 2024
* add spelling check exception * edit format and wording * move validation docs to explanation/ * add mermaid css for accessbility
kissiel
force-pushed
the
add-canary-docs
branch
from
f240504
to
03d6daa
Compare
|
Updated the already stale info about validation outcome. |
LiaoU3
pushed a commit
to LiaoU3/checkbox
that referenced
this pull request
Mar 20, 2024
…anonical#755) * add canary validation process documentation * add missing newline * wip * movement * proper diagram * add sphinx plugin that enables mermaid diagrams * add the validation flow diagrams * add description to subpages * suggest changes to Canary validation docs (infra) (canonical#887) * add spelling check exception * edit format and wording * move validation docs to explanation/ * add mermaid css for accessbility * remove unnecessary TOC * fill the missing things in canary explanation * Use proper name for GitHub * Fix the info about the canary TP * Add explanation to what the `dearest team` queue is * update the info about validation outcome (tag->beta shift) * remove mention of metabox on dailies --------- Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com>
binli
pushed a commit
to binli/checkbox
that referenced
this pull request
Mar 22, 2024
…anonical#755) * add canary validation process documentation * add missing newline * wip * movement * proper diagram * add sphinx plugin that enables mermaid diagrams * add the validation flow diagrams * add description to subpages * suggest changes to Canary validation docs (infra) (canonical#887) * add spelling check exception * edit format and wording * move validation docs to explanation/ * add mermaid css for accessbility * remove unnecessary TOC * fill the missing things in canary explanation * Use proper name for GitHub * Fix the info about the canary TP * Add explanation to what the `dearest team` queue is * update the info about validation outcome (tag->beta shift) * remove mention of metabox on dailies --------- Co-authored-by: tang-mm <3333407+tang-mm@users.noreply.github.com>
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.
Description
The PR enables mermaid diagram rendering in our docs.
This PR introduces a handful of pages describing how we validate edge build of Checkbox.
See individual added pages for details.
When testing the documentation make sure to run
make clean; make installfirst in the docs folder as it needs to add the sphinx-mermaid extensions.