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

Update README and remove pre-commit hooks #105

Merged
merged 1 commit into from
Jul 31, 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
11 changes: 0 additions & 11 deletions .pre-commit-config.yaml

This file was deleted.

27 changes: 3 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ orphan: true

This repository hosts the product documentation for Anbox Cloud.

```{important}
**Important:**
The concepts of the Anbox component in Anbox Cloud are similar to the [Anbox open source project](https://github.com/anbox/anbox), but the Anbox open source project is an independent project that is not related to or used in Anbox Cloud.
```

## Contributing to Anbox Cloud documentation
You can contribute to the Anbox Cloud documentation through either of the following channels:
- Report an issue in GitHub
- Raise a pull request with your changes
- [Report a bug](https://bugs.launchpad.net/anbox-cloud/+bugs) in Launchpad
- Create a pull request with your changes

The Anbox Cloud team will review the issue/pull request and take the necessary action.

Expand Down Expand Up @@ -55,23 +54,3 @@ The following GitHub actions run automatically on every pull request:
- Spellcheck
- Accessibility check
- Link check

**Pre-commit hooks**

To be able to run pre-commit checks, the following prerequisites should be fulfilled:

* Install the `pre-commit` package from the Ubuntu repositories.
* Install the `aspell` and `aspell-en` packages from the Ubuntu repositories. This is required by the spellchecker.
* Navigate to the top-level directory of this repository and run `pre-commit install --install-hooks`.

When the prerequisites are met, the following pre-commit checks are run automatically before every commit. They help in resolving basic issues before committing your changes.

- Inclusive language checks (`woke`)
- Spellcheck (`spellcheck`)

Enabling pre-commit checks are optional as these checks are executed on pull requests automatically. If you do not want to run these checks before commits or to skip a particular check, use the following tips:

* To disable the pre-commit hook, use `--no-verify` when running `git commit`.
* To skip a particular pre-commit check, prefix `SKIP=<pre-commit-hook-name>` when running `git commit`.
* To allow a valid word that is regularly used in the documentation but is flagged by `spellcheck`, add the word to `.wordlist.txt`.
* In special cases, there are ways to avoid a particular file or text from being flagged by `woke`. See [woke user guide](https://docs.getwoke.tech/ignore/).
3 changes: 1 addition & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ We welcome community involvement through suggestions, fixes and constructive fee
- [Discourse](https://discourse.ubuntu.com/c/anbox-cloud/users/148)
- [Matrix](https://matrix.to/#/#anbox-cloud:ubuntu.com)
- {ref}`Troubleshoot Anbox Cloud <howto-ts-anbox-cloud>`
- [Report a bug](https://bugs.launchpad.net/anbox-cloud/+bugs)
- [Report a bug](https://bugs.launchpad.net/anbox-cloud/+bugs) with the product or documentation
- {ref}`contribute`
- [Report an issue with Anbox Cloud documentation](https://github.com/canonical/anbox-cloud-docs/issues/new)

The following resources help you get familiar with Anbox Cloud, its releases and roadmap:

Expand Down
Loading