Skip to content

Commit

Permalink
Update docs and README to the latest directory structure
Browse files Browse the repository at this point in the history
  • Loading branch information
shatakshiiii committed Apr 22, 2024
1 parent e65810f commit ee65075
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,13 @@ $ tree -lla /home/ansible-dev/collections/ansible_collections/testns/testname
│ └── config.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING
├── .devcontainer
│   ├── devcontainer.json
│   ├── docker
│   │   └── devcontainer.json
│   └── podman
│   └── devcontainer.json
├── devfile.yaml
├── docs
│ ├── docsite
│ │ └── links.yml
Expand Down Expand Up @@ -189,7 +196,7 @@ This command will scaffold the ansible-project `new_ansible_project` at `/home/u
Running the init command with parameters `--project`, `--scm-org` and `--scm-project` generates an Ansible Project with a comprehensive directory structure. Explore it using:

```console
$ tree -la /home/ansible-dev/collections/ansible_collections/testns/testname
$ tree -la /home/user/path/to/your/new_ansible_project
.
├── ansible.cfg
├── ansible-navigator.yml
Expand All @@ -210,6 +217,7 @@ $ tree -la /home/ansible-dev/collections/ansible_collections/testns/testname
│   │   └── devcontainer.json
│   └── podman
│   └── devcontainer.json
├── devfile.yaml
├── .github
│   ├── ansible-code-bot.yml
│   └── workflows
Expand Down
1 change: 1 addition & 0 deletions src/ansible_creator/resources/ansible_project/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The directory structure follows best practices recommended by the Ansible commun
| └── hosts.yml
|── ansible-navigator.yml
|── ansible.cfg
|── devfile.yaml
|── linux_playbook.yml
|── network_playbook.yml
|── README.md
Expand Down
1 change: 1 addition & 0 deletions tests/fixtures/project/ansible_project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The directory structure follows best practices recommended by the Ansible commun
| └── hosts.yml
|── ansible-navigator.yml
|── ansible.cfg
|── devfile.yaml
|── linux_playbook.yml
|── network_playbook.yml
|── README.md
Expand Down

0 comments on commit ee65075

Please sign in to comment.