From 2caadd2f4c4b8a276ec06ef2a6c8cd5a3f28bf88 Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Thu, 12 Oct 2023 14:41:29 -0400 Subject: [PATCH] issue-457: Update all occurrences of Ansible core to Ansible Core (#471) (#575) (cherry picked from commit 0bc0a653c5b6af0e5452d4be8ac28d5d186e789d) Co-authored-by: Michelle McCausland <141345897+michellemacrh@users.noreply.github.com> --- README.md | 4 ++-- docs/docsite/rst/community/communication.rst | 2 +- .../docsite/rst/community/documentation_contributions.rst | 8 ++++---- docs/docsite/rst/community/how_can_I_help.rst | 2 +- docs/docsite/rst/core_index.rst | 2 +- .../rst/dev_guide/developing_modules_in_groups.rst | 2 +- docs/docsite/rst/dev_guide/testing.rst | 2 +- .../rst/inventory_guide/intro_dynamic_inventory.rst | 2 +- .../rst/reference_appendices/release_and_maintenance.rst | 2 +- hacking/ticket_stubs/collections.md | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1cf795d6cd..2a707e72f1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # ansible-documentation -This repository holds the ReStructuredText (RST) source, and other files, for user documentation related to the Ansible package and Ansible core. +This repository holds the ReStructuredText (RST) source, and other files, for user documentation related to the Ansible package and Ansible Core. -> Documentation for modules and plugins that are officially supported by the Ansible core engineering team is available in the [`ansible/ansible`](https://github.com/ansible/ansible) repository. +> Documentation for modules and plugins that are officially supported by the Ansible Core engineering team is available in the [`ansible/ansible`](https://github.com/ansible/ansible) repository. ## Building Ansible community documentation diff --git a/docs/docsite/rst/community/communication.rst b/docs/docsite/rst/community/communication.rst index 1dc3a5449a..18eb25d96f 100644 --- a/docs/docsite/rst/community/communication.rst +++ b/docs/docsite/rst/community/communication.rst @@ -182,7 +182,7 @@ Your first post to the mailing list will be moderated (to reduce spam), so pleas * `Ansible Announce list `_ is a read-only list that shares information about new releases of Ansible, and also rare infrequent event information, such as announcements about an upcoming AnsibleFest, which is our official conference series. Worth subscribing to! * `Ansible AWX List `_ is for `Ansible AWX `_ -* `Ansible Development List `_ is for questions about developing Ansible modules (mostly in Python), fixing bugs in the Ansible core code, asking about prospective feature design, or discussions about extending Ansible or features in progress. +* `Ansible Development List `_ is for questions about developing Ansible modules (mostly in Python), fixing bugs in the Ansible Core code, asking about prospective feature design, or discussions about extending Ansible or features in progress. * `Ansible Outreach List `_ help with promoting Ansible and `Ansible Meetups `_ * `Ansible Project List `_ is for sharing Ansible tips, answering questions about playbooks and roles, and general user discussion. * `Molecule Discussions `_ is designed to aid with the development and testing of Ansible roles with Molecule. diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst index e94d3f5219..9732fb644f 100644 --- a/docs/docsite/rst/community/documentation_contributions.rst +++ b/docs/docsite/rst/community/documentation_contributions.rst @@ -99,7 +99,7 @@ Drop the ``--user`` option in the following commands if you use a virtual enviro pip install --user --upgrade pip -#. Clone required parts of Ansible core for the docs build. +#. Clone required parts of Ansible Core for the docs build. .. code-block:: bash @@ -149,13 +149,13 @@ Building the documentation is the best way to check for errors and review your c If building on macOS with Python 3.8 or later, you must use Sphinx >= 2.2.2. See `#6803 `_ for details. -Periodically cloning Ansible core +Periodically cloning Ansible Core ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Documentation in the ``ansible/ansible-documentation`` repository builds "on top of" the ``ansible/ansible`` repository. -When you set up your local build environment, you clone the relevant parts Ansible core. +When you set up your local build environment, you clone the relevant parts Ansible Core. -To ensure that you use the latest source from Ansible core, you should periodically run the following script before you build documentation: +To ensure that you use the latest source from Ansible Core, you should periodically run the following script before you build documentation: .. code-block:: bash diff --git a/docs/docsite/rst/community/how_can_I_help.rst b/docs/docsite/rst/community/how_can_I_help.rst index 38cb1db8d2..8dfd075788 100644 --- a/docs/docsite/rst/community/how_can_I_help.rst +++ b/docs/docsite/rst/community/how_can_I_help.rst @@ -69,7 +69,7 @@ You can also get started with solving GitHub issues labeled with the ``easyfix`` When you choose an issue to work on, add a comment directly on the GitHub issue to say you are looking at it and let others know to avoid conflicting work. You can also ask for help in a comment if you need it. -Another good way to help is to review pull requests that other Ansible users have submitted. Ansible core keeps a full list of `open pull requests by file `_, so if a particular module or plugin interests you, you can easily keep track of all the relevant new pull requests and provide testing or feedback. Alternatively, you can review the pull requests for any collections that interest you. Click :guilabel:`Issue tracker` on the collection documentation page to find the issues and PRs for that collection. +Another good way to help is to review pull requests that other Ansible users have submitted. Ansible Core keeps a full list of `open pull requests by file `_, so if a particular module or plugin interests you, you can easily keep track of all the relevant new pull requests and provide testing or feedback. Alternatively, you can review the pull requests for any collections that interest you. Click :guilabel:`Issue tracker` on the collection documentation page to find the issues and PRs for that collection. Become a collection maintainer ============================== diff --git a/docs/docsite/rst/core_index.rst b/docs/docsite/rst/core_index.rst index e76fe7108c..df678cdc34 100644 --- a/docs/docsite/rst/core_index.rst +++ b/docs/docsite/rst/core_index.rst @@ -12,7 +12,7 @@ About ansible-core Ansible is an IT automation tool. It can configure systems, deploy software, and orchestrate more advanced IT tasks such as continuous deployments or zero downtime rolling updates. -Ansible core, or ``ansible-core`` is the main building block and architecture for Ansible, and includes: +Ansible Core, or ``ansible-core`` is the main building block and architecture for Ansible, and includes: * CLI tools such as ``ansible-playbook``, ``ansible-doc``. and others for driving and interacting with automation. * The Ansible language that uses YAML to create a set of rules for developing Ansible Playbooks and includes functions such as conditionals, blocks, includes, loops, and other Ansible imperatives. diff --git a/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst b/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst index cd44a3ffdc..5f21662894 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst @@ -4,7 +4,7 @@ Creating a new collection ************************* -Starting with Ansible 2.10, related modules should be developed in a collection. The Ansible core team and community compiled these module development tips and tricks to help companies developing Ansible modules for their products and users developing Ansible modules for third-party products. See :ref:`developing_collections` for a more detailed description of the collections format and additional development guidelines. +Starting with Ansible 2.10, related modules should be developed in a collection. The Ansible Core team and community compiled these module development tips and tricks to help companies developing Ansible modules for their products and users developing Ansible modules for third-party products. See :ref:`developing_collections` for a more detailed description of the collections format and additional development guidelines. .. contents:: :local: diff --git a/docs/docsite/rst/dev_guide/testing.rst b/docs/docsite/rst/dev_guide/testing.rst index 6b4716ddfe..ca2fca158b 100644 --- a/docs/docsite/rst/dev_guide/testing.rst +++ b/docs/docsite/rst/dev_guide/testing.rst @@ -32,7 +32,7 @@ At a high level we have the following classifications of tests: * The primary purpose of these tests is to enforce Ansible coding standards and requirements. :integration: * :ref:`testing_integration` - * Functional tests of modules and Ansible core functionality. + * Functional tests of modules and Ansible Core functionality. :units: * :ref:`testing_units` * Tests directly against individual parts of the code base. diff --git a/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst b/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst index e0d9c204f7..3e6bc97627 100644 --- a/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst +++ b/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst @@ -14,7 +14,7 @@ You may need to track hosts from multiple sources: cloud providers, LDAP, `Cobbl Ansible integrates all of these options through a dynamic external inventory system. Ansible supports two ways to connect with external inventory: :ref:`inventory_plugins` and `inventory scripts`. -Inventory plugins take advantage of the most recent updates to the Ansible core code. +Inventory plugins take advantage of the most recent updates to the Ansible Core code. We recommend plugins over scripts for dynamic inventory. You can :ref:`write your own plugin ` to connect to additional dynamic inventory sources. diff --git a/docs/docsite/rst/reference_appendices/release_and_maintenance.rst b/docs/docsite/rst/reference_appendices/release_and_maintenance.rst index 3230e02c9e..e579a3d3d7 100644 --- a/docs/docsite/rst/reference_appendices/release_and_maintenance.rst +++ b/docs/docsite/rst/reference_appendices/release_and_maintenance.rst @@ -405,7 +405,7 @@ The deprecation cycle in ``ansible-core`` is normally across 4 feature releases .. seealso:: :ref:`community_committer_guidelines` - Guidelines for Ansible core contributors and maintainers + Guidelines for Ansible Core contributors and maintainers :ref:`testing_strategies` Testing strategies :ref:`ansible_community_guide` diff --git a/hacking/ticket_stubs/collections.md b/hacking/ticket_stubs/collections.md index 57ab46f11a..b75dfde2d1 100644 --- a/hacking/ticket_stubs/collections.md +++ b/hacking/ticket_stubs/collections.md @@ -2,7 +2,7 @@ Hi! Thank you very much for your submission to Ansible. It means a lot to us that you've taken the time to contribute. -Since Ansible 2.10 we are no longer accepting new modules/plugins into Ansible core. However, we recommend looking into providing this functionality through Ansible Galaxy via Ansible Collections. You can find more information about collections at: +Since Ansible 2.10 we are no longer accepting new modules/plugins into Ansible Core. However, we recommend looking into providing this functionality through Ansible Galaxy via Ansible Collections. You can find more information about collections at: * https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html.