Skip to content

Commit

Permalink
update docs with contributor info (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
oraNod authored Sep 4, 2024
1 parent 99881b4 commit b558106
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

This chart installs the AWX Operator resources configured in [this](https://github.com/ansible/awx-operator) repository.

## Communication

Refer to the
[Getting in touch](https://ansible.readthedocs.io/projects/awx-operator-helm/contributing.html#getting-in-touch)
section of the Contributors guide to find out how to get in touch with us.

You can also find more ways to talk to the community in the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).

## Code of Conduct

Please read and abide by the [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).

## Documentation

- The [Basic usage guide](https://ansible-community.github.io/awx-operator-helm/) provides quickstart information to install the chart.
- The [AWX operator helm chart docsite](https://ansible.readthedocs.io/projects/awx-operator-helm/) provides complete information about installing, using, contributing, and more.

## Getting Started

To configure your AWX resource using this chart, create your own `yaml` values file. The name is up to personal preference since it will explicitly be passed into the helm chart. Helm will merge whatever values you specify in your file with the default `values.yaml`, overriding any settings you've changed while allowing you to fall back on defaults. Because of this functionality, `values.yaml` should not be edited directly.
Expand Down
68 changes: 68 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Contributors guide

Contributions are welcome, and they are greatly appreciated!
Every little bit helps, and credit will always be given.

## Code of conduct

Please read and abide by the [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all interactions with the community.

## Reporting bugs

If you find a bug, please open an issue at <https://github.com/ansible-community/awx-operator-helm/issues>.

Please also include the following information in your issue:

- Your operating system name and the output of `helm show chart awx-operator/awx-operator`
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.

## Writing code

Want to fix a bug or implement a feature?
Great!

Look through the [list of issues](https://github.com/ansible-community/awx-operator-helm/issues) for bugs and features.
You can filter bugs with the `bug` label and features with the `enhancement` label.
Any issue that has the `help wanted` label is available to work on.

Please assign yourself to the issue or add a comment to the issue and ask someone to assign it to you.
We can then remove the `help wanted` label.
That will let others know you're working on it to avoid duplicate work or conflicting pull requests.

## Writing documentation

We encourage you to share your expertise with others in the community.
Writing documentation is a great way to do that.

We can also use help fixing issues with the docs.
Look through the
[list of issues](https://github.com/ansible-community/awx-operator-helm/issues)
for anything with the `docs` label.

Please also refer to the
[Ansible documentation style guide](https://docs.ansible.com/ansible/latest/dev_guide/style_guide/index.html)
when writing or fixing docs.

## Getting in touch

We welcome your feedback, questions and ideas.
Find out how to reach the community.

### Ansible forum

Join the Ansible forum to ask questions, get help, and interact with the
community.

- [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
Please add appropriate tags if you start new discussions, for example use the
`awx` or `awx-operator` tags.
- [Social Spaces](https://forum.ansible.com/c/chat/4): meet and interact with
fellow enthusiasts.
- [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide
announcements including social events.

### Subscribing to project updates

To get release announcements and important changes from the community, see the
[Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ theme:
nav:
- Home: index.md
- helm-install-on-existing-cluster.md
- contributing.md

exclude_docs:
README.md
Expand Down

0 comments on commit b558106

Please sign in to comment.