diff --git a/README.md b/README.md index c0f4d1f2..de5d41d1 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,6 @@ kubectl rollout restart deployment awx-demo Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md). - ## 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. diff --git a/docs/contributors-guide/author.md b/docs/contributors-guide/author.md new file mode 100644 index 00000000..1cdc45d9 --- /dev/null +++ b/docs/contributors-guide/author.md @@ -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 diff --git a/docs/contributors-guide/code-of-conduct.md b/docs/contributors-guide/code-of-conduct.md new file mode 100644 index 00000000..aa9d5b01 --- /dev/null +++ b/docs/contributors-guide/code-of-conduct.md @@ -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) diff --git a/docs/contributors-guide/contributing.md b/docs/contributors-guide/contributing.md new file mode 100644 index 00000000..d762c53a --- /dev/null +++ b/docs/contributors-guide/contributing.md @@ -0,0 +1,3 @@ +## Contributing + +Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md). diff --git a/docs/contributors-guide/get-involved.md b/docs/contributors-guide/get-involved.md new file mode 100644 index 00000000..0845a978 --- /dev/null +++ b/docs/contributors-guide/get-involved.md @@ -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) diff --git a/docs/contributors-guide/release-process.md b/docs/contributors-guide/release-process.md new file mode 100644 index 00000000..6b458cf5 --- /dev/null +++ b/docs/contributors-guide/release-process.md @@ -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