From 52843fcabcc0bee211ebfa1cbe7119f33a8b8c75 Mon Sep 17 00:00:00 2001 From: Bianca Henderson Date: Wed, 12 Dec 2018 14:49:00 -0500 Subject: [PATCH] Making changes to the Community Guide index (#49670) --- .../rst/community/documentation_contributions.rst | 2 +- docs/docsite/rst/community/index.rst | 10 +++++----- docs/docsite/rst/community/release_managers.rst | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst index 8c6eb44522d..84ddb2d8a3e 100644 --- a/docs/docsite/rst/community/documentation_contributions.rst +++ b/docs/docsite/rst/community/documentation_contributions.rst @@ -175,7 +175,7 @@ When you submit a documentation pull request, automated tests are run. Those sam bin/ansible-test sanity --test rstcheck Unfortunately, leftover rST-files from previous document-generating can occasionally confuse these tests. It is therefore safest to run them on a clean copy of the repository, which is the purpose of ``make clean``. If you type these three lines one at a time and manually check the success of each, you do not need the ``&&``. - + Joining the documentation working group ======================================= diff --git a/docs/docsite/rst/community/index.rst b/docs/docsite/rst/community/index.rst index c531cedf9d3..26f3534ca37 100644 --- a/docs/docsite/rst/community/index.rst +++ b/docs/docsite/rst/community/index.rst @@ -14,11 +14,11 @@ This page outlines the most common situations and questions that bring readers t Getting started =============== -* I'm new here. Where can I find the Ansible :ref:`code_of_conduct`? +* I'm new to the community. Where can I find the Ansible :ref:`code_of_conduct`? * I'd like to know what I'm agreeing to when I contribute to Ansible. Does Ansible have a :ref:`contributor_license_agreement`? * I'd like to contribute but I'm not sure how. Are there :ref:`easy ways to contribute `? * I want to talk to other Ansible users. How do I find an `Ansible Meetup near me `_? -* I have a question. What :ref:`Ansible email lists, IRC channels ` will help me find answers? +* I have a question. Which :ref:`Ansible email lists and IRC channels ` will help me find answers? * I want to learn more about Ansible. What can I do? * `Read books `_. @@ -34,7 +34,7 @@ Going deeper ============ * I think Ansible is broken. How do I :ref:`report a bug `? -* I need functionality Ansible doesn't offer. How do I :ref:`request a feature `? +* I need functionality that Ansible doesn't offer. How do I :ref:`request a feature `? * I'm waiting for a particular feature. How do I see what's :ref:`planned for future Ansible Releases `? * I have a specific Ansible interest or expertise (for example, VMware, Linode, etc.). How do I get involved in a :ref:`working group `? * I'd like to participate in conversations about features and fixes. How do I review GitHub issues and pull requests? @@ -47,7 +47,7 @@ Working with the Ansible repo * I want to code my first changes to Ansible. How do I :ref:`set up my Python development environment `? * I'd like to get more efficient as a developer. How can I find :ref:`editors, linters, and other tools ` that will support my Ansible development efforts? * I want my PR to meet Ansible's guidelines. Where can I find guidance on :ref:`coding in Ansible `? -* I want to :ref:`understand the development cycle `. +* I want to learn more about Ansible roadmaps, releases, and projects. How do I find information on :ref:`the development cycle `? * I'd like to connect Ansible to a new API or other resource. How do I :ref:`contribute a group of related modules `? * My pull request is marked ``needs_rebase``. How do I :ref:`rebase my PR `? * I'm using an older version of Ansible and want a bug fixed in my version that's already been fixed on the ``devel`` branch. How do I :ref:`backport a bugfix PR `? @@ -58,7 +58,7 @@ Working with the Ansible repo Traditional Table of Contents ============================= -If you prefer to read the entire Community Guide, here's a list of the pages in order. +If you prefer to read the entire Community Guide, here's a list of the pages in order: .. toctree:: :maxdepth: 2 diff --git a/docs/docsite/rst/community/release_managers.rst b/docs/docsite/rst/community/release_managers.rst index 40dfdc90e64..d7c84cd5ca8 100644 --- a/docs/docsite/rst/community/release_managers.rst +++ b/docs/docsite/rst/community/release_managers.rst @@ -1,7 +1,7 @@ .. _release_managers: ************************** -Release manager guidelines +Release Manager Guidelines ************************** .. contents:: Topics