Skip to content

Commit

Permalink
Fix link for usage.md (Linting playbooks and roles) (#3224)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Ziegenberg <daniel@ziegenberg.at>
  • Loading branch information
ziegenberg committed Mar 28, 2023
1 parent c9c2a54 commit f888a6a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/usage.md
Expand Up @@ -61,9 +61,8 @@ commit.

## Linting playbooks and roles

Ansible-lint recommends following the
{ref}`collection structure layout <collection_structure>` whether you plan to
build a collection or not.
Ansible-lint recommends following the [collection structure layout] whether you
plan to build a collection or not.

Following that layout assures the best integration with all ecosystem tools
because it helps those tools better distinguish between random YAML files and
Expand All @@ -78,6 +77,9 @@ with the `-p` argument. For example, to lint `examples/playbooks/play.yml` and
$ ansible-lint --offline -p examples/playbooks/play.yml examples/roles/bobbins
```

[collection structure layout]:
https://docs.ansible.com/ansible-core/devel/dev_guide/developing_collections_structure.html#collection-structure

## Running example playbooks

Ansible-lint includes an `ansible-lint/examples` folder that contains example
Expand Down

0 comments on commit f888a6a

Please sign in to comment.