Skip to content

Commit

Permalink
Change Getting started EE guide reference to point to the relevant lo…
Browse files Browse the repository at this point in the history
…cation (#1877) (#1879)

(cherry picked from commit 9f3e3f4)

Co-authored-by: Andrew Klychkov <[email protected]>
  • Loading branch information
patchback[bot] and Andersson007 authored Sep 12, 2024
1 parent b5c2240 commit 582464a
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Installing collections in containers
------------------------------------

You can install collections with their dependencies in containers known as Execution Environments.
See `Getting started with Execution Environments <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_ for details.
See :ref:`getting_started_ee_index` for details.

Installing collections with ``ansible-galaxy``
----------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/command_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ Ansible provides ad hoc commands and several utilities for performing various op
`Ansible Navigator <https://ansible.readthedocs.io/projects/navigator/>`_
A command-line tool and a TUI that provides a convenient user interface for most
of the native Ansible command-line utilities and allows to run Ansible automation content
inside containers (`Execution Environments <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_)
inside containers (:ref:`Execution Environments<getting_started_ee_index>`)

Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Example: `meta/runtime.yml <https://github.com/ansible-collections/collection_te
meta/execution-environment.yml
------------------------------

If a collection has controller-side Python package and/or system package requirements, to allow easy `execution environment <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_ building, they SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified <https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/#when-installing-collections-using-ansible-galaxy>`_.
If a collection has controller-side Python package and/or system package requirements, to allow easy :ref:`execution environment<getting_started_ee_index>` building, they SHOULD be listed in corresponding files under the ``meta`` directory, specified in ``meta/execution-environment.yml``, and `verified <https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/#when-installing-collections-using-ansible-galaxy>`_.

See the `Collection-level dependencies guide <https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/#collection-level-dependencies>`_ for more information and `collection_template/meta <https://github.com/ansible-collections/collection_template/tree/main/meta>`_ directory content as an example.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ execution_environments.yml
^^^^^^^^^^^^^^^^^^^^^^^^^^

If your collection has requirements, you can specify them in the ``execution-environment.yml`` file in the ``meta`` directory.
This ensures users do not need to add these requirements manually when building `Execution Environments <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_ containing your collection.
This ensures users do not need to add these requirements manually when building :ref:`Execution Environments<getting_started_ee_index>` containing your collection.
See the `collection-level metadata guide <https://ansible.readthedocs.io/projects/builder/en/stable/collection_metadata/#collection-level-metadata>`_ for details.

.. seealso::
Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/installation_guide/intro_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Installing Ansible to containers
================================

Instead of installing Ansible content manually, you can simply build an execution environment container image or use one of the available community images as your control node.
See the `Getting started with Execution Environments guide <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_ for details.
See :ref:`getting_started_ee_index` for details.

.. _development_install:

Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/shared_snippets/basic_concepts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Control node
============
The machine from which you run the Ansible CLI tools (``ansible-playbook`` , ``ansible``, ``ansible-vault`` and others).
You can use any computer that meets the software requirements as a control node - laptops, shared desktops, and servers can all run Ansible.
You can also run Ansible in containers known as `Execution Environments <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_.
You can also run Ansible in containers known as :ref:`Execution Environments<getting_started_ee_index>`.

Multiple control nodes are possible, but Ansible itself does not coordinate across them, see ``AAP`` for such features.

Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/tips_tricks/ansible_tips_tricks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ These tips apply to using Ansible, rather than to Ansible artifacts.
Use Execution Environments
--------------------------

Reduce complexity with portable container images known as `Execution Environments <https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html>`_.
Reduce complexity with portable container images known as :ref:`Execution Environments<getting_started_ee_index>`.

Try it in staging first
-----------------------
Expand Down

0 comments on commit 582464a

Please sign in to comment.