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

suggest changes to Canary validation docs (infra) #887

Merged
merged 4 commits into from
Jan 4, 2024

Conversation

tang-mm
Copy link
Collaborator

@tang-mm tang-mm commented Dec 12, 2023

Description

Suggested edits on #755

  • moved new docs to docs/explanation/ instead of how-to
  • applied CSS to mermaid style so that diagram text is visible under dark mode (accessibility)
  • excluded mermaid from spelling check
  • In the first diagram for GitHub Workflow, changed node B to use rectangular as it is not a decision point
  • other format and wording changes

Resolved issues

N/A

Documentation

Preview: https://canonical-checkbox.readthedocs-hosted.com/en/doc-preview/explanation/release_process/canary.html

Tests

In the docs/ folder, make install and then make run

@kissiel
Copy link
Contributor

kissiel commented Jan 4, 2024

Thank you very much for the help on this!

@kissiel kissiel merged commit 11e42a0 into add-canary-docs Jan 4, 2024
2 checks passed
@kissiel kissiel deleted the canary-docs-suggest branch January 4, 2024 13:17
kissiel pushed a commit that referenced this pull request Jan 5, 2024
* add spelling check exception

* edit format and wording

* move validation docs to explanation/

* add mermaid css for accessbility
kissiel pushed a commit that referenced this pull request Jan 8, 2024
* add spelling check exception

* edit format and wording

* move validation docs to explanation/

* add mermaid css for accessbility
kissiel added a commit that referenced this pull request Jan 9, 2024
)

* 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) (#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>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants