internet/awx-operator
3
0
Fork 0
mirror of https://github.com/ansible/awx-operator.git synced 2026-05-07 05:42:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: added contributing segment to docs (#1483)

Browse Source
This commit is contained in:
Oluchi Nwenyi
2023-07-27 20:07:30 +01:00
committed by GitHub
parent 93a7878ab7
commit dc2599b0b9
6 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/contributors-guide/author.md Normal file
View File

@@ -0,0 +1,3 @@
## Author
This operator was originally built in 2019 by [Jeff Geerling](https://www.jeffgeerling.com) and is now maintained by the Ansible Team

3
docs/contributors-guide/code-of-conduct.md Normal file
View File

@@ -0,0 +1,3 @@
## Code of Conduct
We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com)

3
docs/contributors-guide/contributing.md Normal file
View File

@@ -0,0 +1,3 @@
## Contributing
Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).

6
docs/contributors-guide/get-involved.md Normal file
View File

@@ -0,0 +1,6 @@
## Get Involved
We welcome your feedback and ideas. The AWX operator uses the same mailing list and IRC channel as AWX itself. Here's how to reach us with feedback and questions:
- Join the `#ansible-awx` channel on irc.libera.chat
- Join the [mailing list](https://groups.google.com/forum/#!forum/awx-project)

10
docs/contributors-guide/release-process.md Normal file
View File

@@ -0,0 +1,10 @@
## Release Process
The first step is to create a draft release. Typically this will happen in the [Stage Release](https://github.com/ansible/awx/blob/devel/.github/workflows/stage.yml) workflow for AWX and you don't need to do it as a separate step.
If you need to do an independent release of the operator, you can run the [Stage Release](https://github.com/ansible/awx-operator/blob/devel/.github/workflows/stage.yml) in the awx-operator repo. Both of these workflows will run smoke tests, so there is no need to do this manually.
After the draft release is created, publish it and the [Promote AWX Operator image](https://github.com/ansible/awx-operator/blob/devel/.github/workflows/promote.yaml) will run, which will:
- Publish image to Quay
- Release Helm chart