diff --git a/contribute/landing.md b/contribute/landing.md index 8d7c8a37..c9526a5a 100644 --- a/contribute/landing.md +++ b/contribute/landing.md @@ -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: diff --git a/index.md b/index.md index 5b188d1f..37b3ce83 100644 --- a/index.md +++ b/index.md @@ -41,6 +41,6 @@ tutorial/landing howto/landing explanation/landing reference/landing -Project and community +Contribute reference/release-notes/release-notes ```