Skip to content

Commit 37e32d6

Browse files
authored
Update docs and README to the latest directory structure (#145)
1 parent e65810f commit 37e32d6

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

docs/installing.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,13 @@ $ tree -lla /home/ansible-dev/collections/ansible_collections/testns/testname
7777
│ └── config.yaml
7878
├── CODE_OF_CONDUCT.md
7979
├── CONTRIBUTING
80+
├── .devcontainer
81+
│   ├── devcontainer.json
82+
│   ├── docker
83+
│   │   └── devcontainer.json
84+
│   └── podman
85+
│   └── devcontainer.json
86+
├── devfile.yaml
8087
├── docs
8188
│ ├── docsite
8289
│ │ └── links.yml
@@ -189,7 +196,7 @@ This command will scaffold the ansible-project `new_ansible_project` at `/home/u
189196
Running the init command with parameters `--project`, `--scm-org` and `--scm-project` generates an Ansible Project with a comprehensive directory structure. Explore it using:
190197

191198
```console
192-
$ tree -la /home/ansible-dev/collections/ansible_collections/testns/testname
199+
$ tree -la /home/user/path/to/your/new_ansible_project
193200
.
194201
├── ansible.cfg
195202
├── ansible-navigator.yml
@@ -210,6 +217,7 @@ $ tree -la /home/ansible-dev/collections/ansible_collections/testns/testname
210217
│   │   └── devcontainer.json
211218
│   └── podman
212219
│   └── devcontainer.json
220+
├── devfile.yaml
213221
├── .github
214222
│   ├── ansible-code-bot.yml
215223
│   └── workflows

src/ansible_creator/resources/ansible_project/README.md.j2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The directory structure follows best practices recommended by the Ansible commun
3333
| └── hosts.yml
3434
|── ansible-navigator.yml
3535
|── ansible.cfg
36+
|── devfile.yaml
3637
|── linux_playbook.yml
3738
|── network_playbook.yml
3839
|── README.md

tests/fixtures/project/ansible_project/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The directory structure follows best practices recommended by the Ansible commun
3333
| └── hosts.yml
3434
|── ansible-navigator.yml
3535
|── ansible.cfg
36+
|── devfile.yaml
3637
|── linux_playbook.yml
3738
|── network_playbook.yml
3839
|── README.md

0 commit comments

Comments
 (0)