Skip to content

Commit

Permalink
Add EE Getting started references to docs (#1576)
Browse files Browse the repository at this point in the history
* Add EE Getting started references to docs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix

* Fix

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
Andersson007 and pre-commit-ci[bot] authored Jul 17, 2023
1 parent 37567eb commit 2741ede
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 6 deletions.
11 changes: 11 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
13 changes: 8 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down

0 comments on commit 2741ede

Please sign in to comment.