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

docs: fix spelling checks in auto-generated material #1069

Merged
merged 4 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,24 @@ Once merged to the main branch, `po` files, `README.md` with the command line re

You can also contribute to the documentation. It uses [GitHub Markdown Format](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github).

You can propose modifications in 2 ways:
To contribute to the documentation edit the files in the `/docs/` directory after forking and cloning the repo.
Each page on the [documentation website](https://canonical-adsys.readthedocs-hosted.com/en/stable/) also includes
an edit button for making small changes, such as fixing typos.

* Directly on the repo, in the `doc/` directory. Once merged, this will update the repository wiki automatically.
* Via the [edit wiki link](https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages#editing-wiki-pages) of this repository. Once merged, this will update the main repository automatically.
> [!WARNING]
> Much of the reference documentation in `/docs/reference/` is auto-generated.
> Editing the content of these files requires modifying `.go` and `.yaml` files found elsewhere in the repo.
> Some references are generated using `dconf` keys from upstream packages and cannot be edited.
> Changes made directly to reference files will be overwritten in the automation process.
> If you want to propose a change to a reference page please make your edits in the relevant source files
> or contact someone on the ADSys team if you are uncertain how to do so.

Each page is a different chapter, ordered with numbers, which is available with the command `adsysctl doc`.
Documentation for the AD integration client `adsysctl` can be generated in the terminal with:

```
adsysctl doc [CHAPTER] [flags]
```
Each page is a different chapter ordered with numbers.

## Contributing to the code

Expand Down
4 changes: 3 additions & 1 deletion docs/.sphinx/spellingcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ matrix:
- .custom_wordlist.txt
output: .sphinx/.wordlist.dic
sources:
- _build/**/*.html
# check all docs except technical reference
- _build/**/*.html|!_build/reference/policies/**/*.html
pipeline:
- pyspelling.filters.html:
comments: false
Expand All @@ -28,3 +29,4 @@ matrix:
- img
- a.p-navigation__link
- a.contributor
- a.reference.internal # don't spellcheck refs hidden in html source

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Privilege Authorisation
# Privilege Authorization

```{toctree}
:maxdepth: 99
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Computer Scripts/index
Power Management/index
Privilege Authorisation/index
Privilege Authorization/index
System Drive Mapping/index
System proxy configuration/index
System-wide application confinement/index
Expand Down
Loading