From dd006e0182bf482c9543833d9f33068f8e762d91 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 6 Sep 2023 15:46:54 +0200 Subject: [PATCH] Contributing guidelines: improve (#1600) * contributing guidelines: improve * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Shatakshi Mishra --- .github/CONTRIBUTING.md | 8 ++++++++ README.md | 13 +++++++++++++ 2 files changed, 21 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 929911123..693ffa89d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -80,6 +80,9 @@ along with its additional dependencies required for testing. pip install -e .\[test] ``` +In case of any errors, try to run `pip install --upgrade pip`. Then run the +above command again. + [virtual environment]: https://docs.python.org/3/library/venv.html ### Testing process and examples @@ -208,6 +211,9 @@ modify accordingly if needed. ## Contributing docs +The documentation source code is located under the [docs][docs source] directory +in the repository's root. + We use [mkdocs](https://www.mkdocs.org/) to generate our docs website. You can trigger the process locally by executing: @@ -221,3 +227,5 @@ $ tox -e docs It is also integrated with [Read The Docs](https://readthedocs.org/) that builds and publishes each commit to the main branch and generates live docs previews for each pull request. + +[docs source]: https://github.com/ansible/ansible-navigator/tree/main/docs diff --git a/README.md b/README.md index 589ba6c9c..4a76f40ad 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,19 @@ A demo of the interface can be found [on YouTube][YT demo]. [//]: # (DO-NOT-REMOVE-docs-intro-END) +## Contributing + +Any kind of contribution to this project is very welcome and appreciated, +whether it is a documentation improvement, [bug report][issue], +[pull request][pull request] review, or a patch. + +See the [Contributing guidelines][contributing guidelines] for details. + +[issue]:https://github.com/ansible/ansible-navigator/issues +[pull request]:https://github.com/ansible/ansible-navigator/pulls +[contributing guidelines]: +https://ansible.readthedocs.io/projects/navigator/contributing/guidelines/ + ## Quick start ### Installing