├── .gitattributes ├── .github ├── .jira_sync_config.yaml └── workflows │ └── pytest.yml ├── .gitignore ├── .vale.ini ├── LICENSE.txt ├── README.md ├── action.yml ├── adding-dictionary-terms.md ├── en ├── index.md └── metadata.yaml ├── getting-started.md ├── media ├── logo.png └── logo.svg ├── metadata.yaml ├── styles ├── Canonical │ ├── 000-US-spellcheck.yml │ ├── 001-English-words-spelling-suggestions.yml │ ├── 003-Ubuntu-names-versions.yml │ ├── 004-Canonical-product-names.yml │ ├── 005-Industry-product-names.yml │ ├── 006-Contractions-forbidden.yml │ ├── 007-Headings-sentence-case.yml │ ├── 008-Headings-no-period.yml │ ├── 009-Headings-no-links.yml │ ├── 010-Punctuation-double-spaces.yml │ ├── 011-Headings-not-followed-by-heading.yml │ ├── 012-Date-format.yml │ ├── 013-Spell-out-numbers-below-10.yml │ ├── 014a-Numbers-greater-than-nine-should-be-in-numeric-form.yml │ ├── 014b-Numbers-with-five-or-more-digits-must-have-comma-separators.yml │ ├── 015-No-prompts-in-comments.yml │ ├── 016-No-inline-comments.yml │ ├── 017-Avoid-long-code-blocks.yml │ ├── 019-no-google-drive-images.yml │ ├── 020-Cliche-words-and-phrases.yml │ ├── 025a-latinisms-with-english-equivalents.yml │ ├── 025b-latinisms-to-reconsider.yml │ ├── 025c-latinisms-to-avoid.yml │ ├── 400-Enforce-inclusive-terms.yml │ └── 500-Repeated-words.yml └── config │ ├── dictionaries │ ├── en_US.aff │ └── en_US.dic │ └── vocabularies │ └── Canonical │ ├── accept.txt │ └── reject.txt ├── tests ├── conftest.py ├── data │ ├── manifest.yml │ └── schema.json ├── requirements.txt └── test_rules.py ├── vale.ini └── versions /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | -------------------------------------------------------------------------------- /.github/.jira_sync_config.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/.github/.jira_sync_config.yaml -------------------------------------------------------------------------------- /.github/workflows/pytest.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/.github/workflows/pytest.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/.gitignore -------------------------------------------------------------------------------- /.vale.ini: -------------------------------------------------------------------------------- 1 | vale.ini -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/LICENSE.txt -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/README.md -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/action.yml -------------------------------------------------------------------------------- /adding-dictionary-terms.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/adding-dictionary-terms.md -------------------------------------------------------------------------------- /en/index.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/en/index.md -------------------------------------------------------------------------------- /en/metadata.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/en/metadata.yaml -------------------------------------------------------------------------------- /getting-started.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/getting-started.md -------------------------------------------------------------------------------- /media/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/media/logo.png -------------------------------------------------------------------------------- /media/logo.svg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/media/logo.svg -------------------------------------------------------------------------------- /metadata.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/metadata.yaml -------------------------------------------------------------------------------- /styles/Canonical/000-US-spellcheck.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/000-US-spellcheck.yml -------------------------------------------------------------------------------- /styles/Canonical/001-English-words-spelling-suggestions.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/001-English-words-spelling-suggestions.yml -------------------------------------------------------------------------------- /styles/Canonical/003-Ubuntu-names-versions.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/003-Ubuntu-names-versions.yml -------------------------------------------------------------------------------- /styles/Canonical/004-Canonical-product-names.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/004-Canonical-product-names.yml -------------------------------------------------------------------------------- /styles/Canonical/005-Industry-product-names.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/005-Industry-product-names.yml -------------------------------------------------------------------------------- /styles/Canonical/006-Contractions-forbidden.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/006-Contractions-forbidden.yml -------------------------------------------------------------------------------- /styles/Canonical/007-Headings-sentence-case.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/007-Headings-sentence-case.yml -------------------------------------------------------------------------------- /styles/Canonical/008-Headings-no-period.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/008-Headings-no-period.yml -------------------------------------------------------------------------------- /styles/Canonical/009-Headings-no-links.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/009-Headings-no-links.yml -------------------------------------------------------------------------------- /styles/Canonical/010-Punctuation-double-spaces.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/010-Punctuation-double-spaces.yml -------------------------------------------------------------------------------- /styles/Canonical/011-Headings-not-followed-by-heading.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/011-Headings-not-followed-by-heading.yml -------------------------------------------------------------------------------- /styles/Canonical/012-Date-format.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/012-Date-format.yml -------------------------------------------------------------------------------- /styles/Canonical/013-Spell-out-numbers-below-10.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/013-Spell-out-numbers-below-10.yml -------------------------------------------------------------------------------- /styles/Canonical/014a-Numbers-greater-than-nine-should-be-in-numeric-form.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/014a-Numbers-greater-than-nine-should-be-in-numeric-form.yml -------------------------------------------------------------------------------- /styles/Canonical/014b-Numbers-with-five-or-more-digits-must-have-comma-separators.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/014b-Numbers-with-five-or-more-digits-must-have-comma-separators.yml -------------------------------------------------------------------------------- /styles/Canonical/015-No-prompts-in-comments.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/015-No-prompts-in-comments.yml -------------------------------------------------------------------------------- /styles/Canonical/016-No-inline-comments.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/016-No-inline-comments.yml -------------------------------------------------------------------------------- /styles/Canonical/017-Avoid-long-code-blocks.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/017-Avoid-long-code-blocks.yml -------------------------------------------------------------------------------- /styles/Canonical/019-no-google-drive-images.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/019-no-google-drive-images.yml -------------------------------------------------------------------------------- /styles/Canonical/020-Cliche-words-and-phrases.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/020-Cliche-words-and-phrases.yml -------------------------------------------------------------------------------- /styles/Canonical/025a-latinisms-with-english-equivalents.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/025a-latinisms-with-english-equivalents.yml -------------------------------------------------------------------------------- /styles/Canonical/025b-latinisms-to-reconsider.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/025b-latinisms-to-reconsider.yml -------------------------------------------------------------------------------- /styles/Canonical/025c-latinisms-to-avoid.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/025c-latinisms-to-avoid.yml -------------------------------------------------------------------------------- /styles/Canonical/400-Enforce-inclusive-terms.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/400-Enforce-inclusive-terms.yml -------------------------------------------------------------------------------- /styles/Canonical/500-Repeated-words.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/Canonical/500-Repeated-words.yml -------------------------------------------------------------------------------- /styles/config/dictionaries/en_US.aff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/config/dictionaries/en_US.aff -------------------------------------------------------------------------------- /styles/config/dictionaries/en_US.dic: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/config/dictionaries/en_US.dic -------------------------------------------------------------------------------- /styles/config/vocabularies/Canonical/accept.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/styles/config/vocabularies/Canonical/accept.txt -------------------------------------------------------------------------------- /styles/config/vocabularies/Canonical/reject.txt: -------------------------------------------------------------------------------- 1 | ROCKcraft 2 | Snapd -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/tests/conftest.py -------------------------------------------------------------------------------- /tests/data/manifest.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/tests/data/manifest.yml -------------------------------------------------------------------------------- /tests/data/schema.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/tests/data/schema.json -------------------------------------------------------------------------------- /tests/requirements.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/tests/requirements.txt -------------------------------------------------------------------------------- /tests/test_rules.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/tests/test_rules.py -------------------------------------------------------------------------------- /vale.ini: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/canonical/documentation-style-guide/HEAD/vale.ini -------------------------------------------------------------------------------- /versions: -------------------------------------------------------------------------------- 1 | master 2 | --------------------------------------------------------------------------------