Skip to content

Commit

Permalink
Improve contributing guide canonical#131
Browse files Browse the repository at this point in the history
Rename TOC heading to contribute. Add prerequisite for contributing to docs. Include quality checks by listing GitHub actions.
  • Loading branch information
PitifulPete committed Sep 27, 2024
1 parent 8255967 commit 3f13fc5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 10 additions & 1 deletion contribute/landing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,18 @@ We welcome contributions, suggestions, fixes and constructive feedback from the
- Report it as a bug on [Launchpad](https://bugs.launchpad.net/anbox-cloud/+bugs) or on [GitHub](https://github.com/canonical/anbox-cloud-docs/issues/new).
- Talk to us on the [public Matrix channel](https://matrix.to/#/#anbox-cloud:ubuntu.com).

Contributing to our documentation is straightforward. We only require that all contributors sign the [Canonical contributor license agreement](https://ubuntu.com/legal/contributors), have a GitHub account, and set up a [git environment](https://github.com/canonical/open-documentation-academy/blob/main/getting-started/get_started.md#getting-your-environment-set-up).

The navigational structure, style, and content of our documentation follows the Diátaxis systematic framework for technical documentation. This categorises the documentation into tutorials, how-to guides, reference material and explanatory text.

Consistency is vital in documentation, which is why we request contributors to follow the {ref}`style-guide`. However, do not let this be a barrier to your contribution. You can still submit contributions to the best of your ability, and if something is inconsistent, we will fix it. We are targeting continuous improvement rather than delayed perfection.
Consistency is vital in documentation, which is why we request contributors to follow the {ref}`style-guide`. We also set up the following GitHub actions to run automatically on every pull request raised against our docs repository:

- Inclusive language check
- Spellcheck
- Accessibility check
- Link check.

However, do not let this be a barrier to your contribution. You can still submit contributions to the best of your ability, and if something is inconsistent, we will fix it. We are targeting continuous improvement rather than delayed perfection.

```{toctree}
:hidden:
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ tutorial/landing
howto/landing
explanation/landing
reference/landing
Project and community <contribute/landing>
Contribute <contribute/landing>
reference/release-notes/release-notes
```

0 comments on commit 3f13fc5

Please sign in to comment.