Skip to content

Commit

Permalink
Docs: added contributing segment to docs (#1483)
Browse files Browse the repository at this point in the history
  • Loading branch information
LuluNwenyi authored Jul 27, 2023
1 parent 93a7878 commit dc2599b
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 1 deletion.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/contributors-guide/author.md
Original file line number Diff line number Diff line change
@@ -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 changes: 3 additions & 0 deletions docs/contributors-guide/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected])
3 changes: 3 additions & 0 deletions docs/contributors-guide/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Contributing

Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).
6 changes: 6 additions & 0 deletions docs/contributors-guide/get-involved.md
Original file line number Diff line number Diff line change
@@ -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 changes: 10 additions & 0 deletions docs/contributors-guide/release-process.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit dc2599b

Please sign in to comment.