Docs: Typos and edits in collections reviews (#79217)

docs/docsite/rst/community/collection_contributors/collection_reviewing.rst

@@ -10,20 +10,20 @@ Reviewing bug reports
 
 When users report bugs, verify the behavior reported. Remember always to be kind with your feedback.
 
-*  Did the user made a mistake in the code they put in the Steps to reproduce issue's section? We often see user errors reported as bugs.
+*  Did the user make a mistake in the code they put in the Steps to Reproduce issue section? We often see user errors reported as bugs.
 *  Did the user assume an unexpected behavior? Ensure that the related documentation is clear. If not, the issue is useful to help us improve documentation.
 *  Is there a minimal reproducer? If not, ask the reporter to reduce the complexity to help pinpoint the issue.
-*  Is the issue a consequence of wrong-configured environment?
+*  Is the issue a consequence of a misconfigured environment?
-*  If it seems to be real bug, does the behaviour still exist in the most recent release or the development branch?
+*  If it seems to be a real bug, does the behaviour still exist in the most recent release or the development branch?
 *  Reproduce the bug, or if you do not have a suitable infrastructure, ask other contributors to reproduce the bug.
 
 
 Reviewing suggested changes
 ---------------------------
 
-When reviewing PRs, verify the suggested changes first. Do not:
+When reviewing PRs, verify that the suggested changes do not:
 
-*  Unnecessarily break backwards compatibility.
+*  Unnecessarily break backward compatibility.
 *  Bring more harm than value.
 *  Introduce non-idempotent solutions.
 *  Duplicate already existing features (inside or outside the collection).
@@ -32,7 +32,7 @@ When reviewing PRs, verify the suggested changes first. Do not:
 
 Other standards to check for in a PR include:
 
-*  A pull request MUST NOT contain a mix of bugfixes and new features that are not tightly related. If yes, ask the author to split the pull request into separate PRs.
+*  A pull request MUST NOT contain a mix of bug fixes and new features that are not tightly related. If yes, ask the author to split the pull request into separate PRs.
 *  If the pull request is not a documentation fix, it must include a :ref:`changelog fragment <collection_changelog_fragments>`. Check the format carefully as follows:
 
   * New modules and plugins (that are not jinja2 filter and test plugins) do not need changelog fragments.
@@ -45,7 +45,7 @@ Other standards to check for in a PR include:
 *  If a new plugin is added, it is one of the `allowed plugin types <https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#modules-plugins>`_.
 *  Documentation, examples, and return sections use FQCNs for the ``M(..)`` :ref:`format macros <module_documents_linking>` when referring to modules.
 *  Modules and plugins from ansible-core use ``ansible.builtin.`` as an FQCN prefix when mentioned.
-*  When a new option, module, plugin, or return value is added, the corresponding documentation or return sections use ``version_added:`` containing the *collection* version which they will be first released in.
+*  When a new option, module, plugin, or return value is added, the corresponding documentation or return sections use ``version_added:`` containing the *collection* version in which they will be first released.
 
   * This  is typically the next minor release, sometimes the next major release. For example: if 2.7.5 is the current release, the next minor release will be 2.8.0, and the next major release will be 3.0.0).
 
@@ -70,5 +70,5 @@ Review for merge commits and breaking changes
 ---------------------------------------------
 
 *  The pull request does not contain merge commits. See the GitHub warnings at the bottom of the pull request. If merge commits are present, ask the author to rebase the pull request branch.
-*  If the pull request contains breaking changes, ask the author and the collection maintainers if it really is needed, and there is a way not to introduce breaking changes. If breaking changes are present, they MUST only appear in the next major release and MUST NOT appear in a minor or patch release. The only exception is breaking changes caused by security fixes that are absolutely necessary to fix the security issue.
+*  If the pull request contains breaking changes, ask the author and the collection maintainers if it really is needed, and if there is a way not to introduce breaking changes. If breaking changes are present, they MUST only appear in the next major release and MUST NOT appear in a minor or patch release. The only exception is breaking changes caused by security fixes that are absolutely necessary to fix the security issue.
 

docs/docsite/rst/community/maintainers_guidelines.rst

@@ -16,7 +16,7 @@ In general, collection maintainers:
 
 - Act in accordance with the :ref:`code_of_conduct`.
 - Subscribe to the collection repository they maintain (click :guilabel:`Watch > All activity` in GitHub).
-- Keep README, development guidelines, and other general collection :ref:`maintainer_documentation` relevant.
+- Keep README, development guidelines, and other general collections :ref:`maintainer_documentation` relevant.
 - Review and commit changes made by other contributors.
 - :ref:`Backport <Backporting>` changes to stable branches.
 - Address or assign issues to appropriate contributors.
@@ -32,7 +32,7 @@ Multiple maintainers can divide responsibilities among each other.
 How to become a maintainer
 --------------------------
 
-A person interested in becoming a maintainer and satisfies the :ref:`requirements<maintainer_requirements>` may either self-nominate or be nominated by another maintainer.
+A person interested in becoming a maintainer and satisfying the :ref:`requirements<maintainer_requirements>` may either self-nominate or be nominated by another maintainer.
 
 To nominate a candidate, create a GitHub issue in the relevant collection repository. If there is no response, the repository is not actively maintained, or the current maintainers do not have permissions to add the candidate, please create the issue in the `ansible/community <https://github.com/ansible/community>`_ repository.
 
@@ -44,7 +44,7 @@ Communicating as a collection maintainer
 
 Collection contributors and maintainers should also communicate through:
 
-* :ref:`communication_irc` appropriate to their collection, or if none exist, the general community and developer chat channels
+* :ref:`communication_irc` appropriate to their collection, or if none exists, the general community and developer chat channels
 * Mailing lists such as `ansible-announce <https://groups.google.com/d/forum/ansible-announce>`_ and `ansible-devel <https://groups.google.com/d/forum/ansible-devel>`_
 * Collection project boards, issues, and GitHub discussions in corresponding repositories
 * Quarterly Contributor Summits.
@@ -65,7 +65,7 @@ Contributor Summits
 -------------------
 
 
-The quarterly Ansible Contributor Summit is a global event that provides our contributors a great opportunity to meet each other, communicate, share ideas, and see that there are other real people behind the messages on Matrix or Libera Chat IRC or GitHub. This gives a sense of community. Watch the `Bullhorn newsletter <https://github.com/ansible/community/wiki/News#the-bullhorn>`_ for information when the next contributor summit, invite contributors you know, and take part in the event together.
+The quarterly Ansible Contributor Summit is a global event that provides our contributors a great opportunity to meet each other, communicate, share ideas, and see that there are other real people behind the messages on Matrix or Libera Chat IRC, or GitHub. This gives a sense of community. Watch the `Bullhorn newsletter <https://github.com/ansible/community/wiki/News#the-bullhorn>`_ for information when the next contributor summit, invite contributors you know, and take part in the event together.
 
 Weekly community Matrix/IRC meetings
 ------------------------------------
@@ -102,13 +102,13 @@ Here are some ways you can expand the community around your collection:
 Encouraging new contributors
 -----------------------------
 
-Easy fix items are the best way to attract and mentor new contributors. You should triage incoming issues to mark them with labels such as ``easyfix``, ``waiting_on_contributor``, and ``docs``. where appropriate. Do not fix these trivial non-critical bugs yourself. Instead, mentor a person who wants to contribute.
+Easy-fix items are the best way to attract and mentor new contributors. You should triage incoming issues to mark them with labels such as ``easyfix``, ``waiting_on_contributor``, and ``docs``. where appropriate. Do not fix these trivial non-critical bugs yourself. Instead, mentor a person who wants to contribute.
 
-For some easy fix issues, you could ask the issue reporter whether they want to fix the issue themselves providing the link to a quickstart guide for creating PRs.
+For some easy-fix issues, you could ask the issue reporter whether they want to fix the issue themselves providing the link to a quick start guide for creating PRs.
 
-Conduct pull request days regularly. You could plan PR days, for example, in the last Friday of every month when you and other maintainers go through all open issues and pull requests focusing on old ones, asking people if you can help, and so on. If there are pull requests that look abandoned (for example, there is no response on your help offers since the previous PR day), announce that anyone else interested can complete the pull request.
+Conduct pull request days regularly. You could plan PR days, for example, on the last Friday of every month when you and other maintainers go through all open issues and pull requests focusing on old ones, asking people if you can help, and so on. If there are pull requests that look abandoned (for example, there is no response on your help offers since the previous PR day), announce that anyone else interested can complete the pull request.
 
-Promote active contributors satisfying :ref:`requirements<maintainer_requirements>` to maintainers. Revise contributors activity regularly.
+Promote active contributors satisfying :ref:`requirements<maintainer_requirements>` to maintainers. Revise contributors' activity regularly.
 
 If your collection found new maintainers, announce that fact in the `Bullhorn newsletter <https://github.com/ansible/community/wiki/News#the-bullhorn>`_ and during the next Contributor Summit congratulating and thanking them for the work done. You can mention all the people promoted since the previous summit. Remember to invite the other maintainers to the Summit in advance.
 
@@ -118,8 +118,8 @@ Some other general guidelines to encourage contributors:
 * If there is a non-crucial easy-fix bug reported, politely ask the author to fix it themselves providing a link to :ref:`collection_quickstart`.
 * When suggesting changes, try to use questions, not statements.
 * When suggesting mandatory changes, do it as politely as possible providing documentation references.
-* If your suggestion is optional or a matter of personal preferences, please say it explicitly.
+* If your suggestion is optional or a matter of personal preference, please say it explicitly.
-* When asking for adding tests or for complex code refactoring, say that the author is welcome to ask for clarifications and help if they need.
+* When asking for adding tests or for complex code refactoring, say that the author is welcome to ask for clarifications and help if they need it.
 * If somebody suggests a good idea, mention it or put a thumbs up.
 * After merging, thank the author and reviewers for their time and effort.
 
@@ -140,7 +140,7 @@ A good ``README`` includes a description of the collection, a link to the :ref:`
 
  The ``CONTRIBUTING`` file includes all the details or links to the details on how a new or continuing contributor can contribute to this collection. The ``CONTRIBUTING`` file should include:
 
-* Information or links to new contributor guidelines, such as a quickstart on opening PRs.
+* Information or links to new contributor guidelines, such as a quick start on opening PRs.
 * Information or links to contributor requirements, such as unit and integration test requirements.
 
 You can optionally include a ``CONTRIBUTORS`` and ``MAINTAINERS`` file to list the collection contributors and maintainers.

docs/docsite/rst/community/maintainers_workflow.rst

@@ -31,10 +31,10 @@ Module maintainers
 ------------------
 
 Module-scope maintainers exist in collections that have the `collection bot <https://github.com/ansible-community/collection_bot>`_,
-for example `community.general <https://github.com/ansible-collections/community.general>`_
+for example, `community.general <https://github.com/ansible-collections/community.general>`_
 and `community.network <https://github.com/ansible-collections/community.network>`_.
 
-Being a module maintainer is the stage prior to becoming a collection maintainer. Module maintainers are contributors who are listed in ``.github/BOTMETA.yml``. The scope can be any file (for example, a module or plugin), directory, or repository. Because in most cases the scope is a module or group of modules, we call these contributors module maintainers. The collection bot notifies module maintainers when issues / pull requests related to files they maintain are created.
+Being a module maintainer is the stage prior to becoming a collection maintainer. Module maintainers are contributors who are listed in ``.github/BOTMETA.yml``. The scope can be any file (for example, a module or plugin), directory, or repository. Because in most cases the scope is a module or group of modules, we call these contributors module maintainers. The collection bot notifies module maintainers when issues/pull requests related to files they maintain are created.
 
 Module maintainers have indirect commit rights implemented through the `collection bot <https://github.com/ansible-community/collection_bot>`_.
 When two module maintainers comment with the keywords ``shipit``, ``LGTM``, or ``+1`` on a pull request
@@ -47,7 +47,7 @@ see to the `Collection bot overview <https://github.com/ansible-community/collec
 Releasing a collection
 ----------------------
 
-Collection maintainers are responsible for releasing new versions of a collection. Generally, releasing in the collections consists of:
+Collection maintainers are responsible for releasing new versions of a collection. Generally, releasing a collection consists of:
 
 #. Planning and announcement.
 #. Generating a changelog.
@@ -76,14 +76,14 @@ For convenience, backporting can be implemented automatically using GitHub bots
 Including a collection in Ansible
 -----------------------------------
 
-If a collection is not included in Ansible (not shipped with Ansible package), maintainers can submit the collection for inclusion by creating a discussion under `ansible-collections/ansible-inclusion repository <https://github.com/ansible-collections/ansible-inclusion>`_. For more information, see the `repository's README <https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md>`_, and the `Ansible community package collections requirements <https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst>`.
+If a collection is not included in Ansible (not shipped with Ansible package), maintainers can submit the collection for inclusion by creating a discussion under the `ansible-collections/ansible-inclusion repository <https://github.com/ansible-collections/ansible-inclusion>`_. For more information, see the `repository's README <https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md>`_, and the `Ansible community package collections requirements <https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst>`.
 
 Stepping down as a collection maintainer
 ===========================================
 
 Times change, and so may your ability to continue as a collection maintainer. We ask that you do not step down silently.
 
-If you feel you don't have time to maintain your collection any more, you should:
+If you feel you don't have time to maintain your collection anymore, you should:
 
 - Inform other maintainers about it.
 - If the collection is under the ``ansible-collections`` organization, also inform relevant :ref:`communication_irc`, the ``community`` chat channels on IRC or matrix, or by email ``ansible-community@redhat.com``.