From 640e5db9c6677c2db218a54f987c917c08c58742 Mon Sep 17 00:00:00 2001 From: TVo Date: Mon, 25 Sep 2023 11:24:39 -0600 Subject: Removed references of IRC and fixed formatting in "Work Items" section. (#14478) Co-authored-by: Don Naro --- docs/docsite/rst/contributor/intro.rst | 4 +++- docs/docsite/rst/contributor/report_issues.rst | 6 +++--- docs/docsite/rst/contributor/work_items.rst | 13 ++++++------- 3 files changed, 12 insertions(+), 11 deletions(-) (limited to 'docs/docsite') diff --git a/docs/docsite/rst/contributor/intro.rst b/docs/docsite/rst/contributor/intro.rst index 2bbdecc523..d34a54e6f7 100644 --- a/docs/docsite/rst/contributor/intro.rst +++ b/docs/docsite/rst/contributor/intro.rst @@ -4,4 +4,6 @@ Introduction Hi there! We're excited to have you as a contributor. -Have questions about this document or anything not covered here? Come chat with us at `#ansible-awx` on irc.libera.chat, or submit your question to the `mailing list `_. +Have questions about this document or anything not covered here? Come chat with us and ask questions on Matrix at `#awx:ansible.com `_. + +Also visit the `forum.ansible.com `_ to find contributor resources. Or, submit your question to the `mailing list `_. \ No newline at end of file diff --git a/docs/docsite/rst/contributor/report_issues.rst b/docs/docsite/rst/contributor/report_issues.rst index c16f3fb1d5..fb02cda6ef 100644 --- a/docs/docsite/rst/contributor/report_issues.rst +++ b/docs/docsite/rst/contributor/report_issues.rst @@ -4,12 +4,12 @@ Reporting Issues ================ -To report issues you find in the AWX documentation, use the GitHub [issue tracker](https://github.com/ansible/awx/issues) for filing bugs. In order to save time, and help us respond to issues quickly, make sure to fill out as much of the issue template +To report issues you find in the AWX documentation, use the GitHub `issue tracker `_ for filing bugs. In order to save time, and help us respond to issues quickly, make sure to fill out as much of the issue template as possible. Version information, and an accurate reproducing scenario are critical to helping us identify the problem. Be sure to attach the ``component:docs`` label to your issue. These labels are determined by the template data. Please use the template and fill it out as accurately as possible. -Please don't use the issue tracker as a way to ask how to do something. Instead, use the `mailing list `_, and the ``#ansible-awx`` channel on irc.libera.chat to get help. +Please don't use the issue tracker as a way to ask how to do something. Instead, use the `mailing list `_, or you can chat with us and ask questions on Matrix at `#awx:ansible.com `_. Before opening a new issue, please use the issue search feature to see if what you're experiencing has already been reported. If you have any extra detail to provide, please comment. Otherwise, rather than posting a "me too" comment, please consider giving it a `"thumbs up" `_ to give us an indication of the severity of the problem. @@ -19,4 +19,4 @@ See `How issues are resolved `_, or `Discourse `_. +If you require additional assistance, please reach out to us and ask questions on Matrix at `#awx:ansible.com `_, or submit your question or concern on the `mailing list `_, or the `Discourse Forum `_. diff --git a/docs/docsite/rst/contributor/work_items.rst b/docs/docsite/rst/contributor/work_items.rst index 54c1256e4c..c2f2c82dc0 100644 --- a/docs/docsite/rst/contributor/work_items.rst +++ b/docs/docsite/rst/contributor/work_items.rst @@ -22,20 +22,19 @@ Things to know prior to submitting revisions - You must use ``git commit --signoff`` for any commit to be merged, and agree that usage of ``--signoff`` constitutes agreement with the terms of `DCO 1.1 `_. - Take care to make sure no merge commits are in the submission, and use ``git rebase`` vs ``git merge`` for this reason. - If collaborating with someone else on the same branch, consider using ``--force-with-lease`` instead of ``--force``. This will prevent you from accidentally overwriting commits pushed by someone else. For more information, see `git push docs `_. -- If submitting a large doc change, it's a good idea to join the ``#ansible-docs`` channel on irc.libera.chat or `Discourse `_, and talk about what you would like to do or add first. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed. +- If submitting a large doc change, it's a good idea to join the `Ansible Forum `_, and talk about what you would like to do or add first. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed. - We ask all of our community members and contributors to adhere to the `Ansible code of conduct `_. If you have questions, or need assistance, please reach out to our community team at `codeofconduct@ansible.com `_. -**NOTES** +.. Note:: -> Issue assignment will only be done for maintainers of the project. If you decide to work on an issue, please feel free to add a comment in the issue to let others know that you are working on it; but know that we will accept the first pull request from whomever is able to fix an issue. Once your PR is accepted we can add you as an assignee to an issue upon request. + - Issue assignment will only be done for maintainers of the project. If you decide to work on an issue, please feel free to add a comment in the issue to let others know that you are working on it; but know that we will accept the first pull request from whomever is able to fix an issue. Once your PR is accepted we can add you as an assignee to an issue upon request. + - If you work in a part of the docs that is going through active development, your changes may be rejected, or you may be asked to `rebase`. A good idea before starting work is to have a discussion with us and ask questions on Matrix at `#awx:ansible.com `_ or discuss your ideas on the `Ansible Forum `_. -> If you work in a part of the docs that is going through active development, your changes may be rejected, or you may be asked to `rebase`. A good idea before starting work is to have a discussion with us in the ``#ansible-awx`` channel on irc.libera.chat, or on the `mailing list `_, or `Discourse `_. + - If you find an issue with the functions of the UI or API, please see the `Reporting Issues `_ section to open an issue. -> If you find an issue with the functions of the UI or API, please see the `Reporting Issues `_ section to open an issue. - -> If you find an issue with the docs themselves, refer to :ref:`docs_report_issues`. + - If you find an issue with the docs themselves, refer to :ref:`docs_report_issues`. Translations -- cgit v1.2.3