Skip to content

docs: Change root to Top Level Directory #4174

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

Closed
wants to merge 2 commits into from

Conversation

stuartp44
Copy link
Contributor

@stuartp44 stuartp44 commented Oct 8, 2024

docs: After seeing a few issues being opened regarding failed usage of modules, I think the language surrounding the menus is wrong or misleads a little. I have reworded this to hopefully help.

@stuartp44 stuartp44 changed the title Change root to Top Level Directory docs: Change root to Top Level Directory Oct 8, 2024
@@ -1,4 +1,4 @@
# Runner module (root)
# Runner module (Top Level Directory)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In terraform term we speaking about modules, the ones below the first level (parten / top-level / root) are called submodule. When would like to make it explict here, would prefer to keep it short (so it renders nice). Either parent or top-level.

Suggested change
# Runner module (Top Level Directory)
# Runner module (Top Level)

Copy link
Member

@npalm npalm Oct 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stuartp44 stuartp44 closed this Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants