Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: highlight importance of ansible_collections at root dir #4060

Merged
merged 3 commits into from
Oct 17, 2023

Conversation

felher
Copy link
Contributor

@felher felher commented Sep 30, 2023

Hey all,

thank you for providing molecule <3

I tried to follow the getting started guide but got a role-not-found-error. After some experimenting I found out that my mistake was that I didn't name my collection-root ansible_collections. Other people might make the same mistake I did. So I propose 2 changes:

  • change "the collections/ansible_collections" to "a collections/ansible_collections", since it doesn't seem to matter where that directory lies and, at least on my system, the two ones that already exist are not writable by a normal user by default.
  • Highlight that it is not only recommend, but important that the collections root is named ansible_collections. If you put your collections somewhere else, but follow the guide in every other regard, you will get a "role not found" error.

…t dir

Make it clear in the getting started guide that the root dir you should place your collection under should really be named `ansible_collections`
@felher felher temporarily deployed to ack September 30, 2023 12:37 — with GitHub Actions Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to ack September 30, 2023 12:37 Inactive
@felher
Copy link
Contributor Author

felher commented Sep 30, 2023

Is the tox/docs error due to my changes? I searched the log for the getting-started, because I changed the getting-started.md file, but it came up short. At least for errors.

@ssbarnea ssbarnea changed the title getting-started: highlight importance of ansible_collections as root dir getting-started: highlight importance of ansible_collections at root dir Oct 17, 2023
@ssbarnea ssbarnea added the bug label Oct 17, 2023
@ssbarnea ssbarnea temporarily deployed to ack October 17, 2023 10:52 — with GitHub Actions Inactive
@ssbarnea ssbarnea changed the title getting-started: highlight importance of ansible_collections at root dir Docs: highlight importance of ansible_collections at root dir Oct 17, 2023
@ssbarnea ssbarnea temporarily deployed to ack October 17, 2023 10:52 — with GitHub Actions Inactive
@ssbarnea ssbarnea enabled auto-merge (squash) October 17, 2023 10:58
@ssbarnea ssbarnea merged commit 96eedb1 into ansible:main Oct 17, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants