diff --git a/docs/faq.md b/docs/faq.md index 158401b9c..66d7b08cb 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,6 +2,17 @@ [TOC] +## Execution environments + +### What is an execution environment? + +An execution environment is a container image serving as an Ansible control +node. + +See the +[Getting started with Execution Environments guide](https://docs.ansible.com/ansible/devel/getting_started_ee/index.html) +for details. + ## The `ansible.cfg` file ### Where should the `ansible.cfg` file go when using an execution environment? diff --git a/docs/index.md b/docs/index.md index 6ff2f3665..bce35b08d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,18 @@ # Ansible Navigator Documentation -`ansible-navigator` is a command based tool for creating, reviewing, and -troubleshooting Ansible content, including inventories, playbooks, and -collections. - -A text-based user interface (TUI) for Ansible. +`ansible-navigator` is a command-line tool and a text-based user interface (TUI) +for creating, reviewing, running and troubleshooting Ansible content, including +inventories, playbooks, collections, documentation and container images +(execution environments). A demo of the interface can be found [on YouTube][yt demo]. [yt demo]: https://www.youtube.com/watch?v=J9PBKi8ydi4 +To learn how to easily start leveraging the container technology with +`ansible-navigator`, see the +[Getting started with Execution Environments guide](https://docs.ansible.com/ansible/devel/getting_started_ee/index.html). + - [Installation](installation.md) - [Settings](settings.md) - [Subcommands](subcommands.md) diff --git a/src/ansible_navigator/configuration_subsystem/navigator_configuration.py b/src/ansible_navigator/configuration_subsystem/navigator_configuration.py index cfbe314da..e37fd2d5b 100644 --- a/src/ansible_navigator/configuration_subsystem/navigator_configuration.py +++ b/src/ansible_navigator/configuration_subsystem/navigator_configuration.py @@ -103,7 +103,11 @@ class Internals: navigator_subcommands = [ SubCommand( name="builder", - description="Build execution environment (container image)", + description=( + "Build [execution environment]" + "(https://docs.ansible.com/ansible/devel/getting_started_ee/index.html) " + "(container image)" + ), epilog=( "Note: 'ansible-navigator builder' additionally supports" " the same parameters as the 'ansible-builder' command."