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

Document Module Naming guidelines in the Docs #13

Open
DonGiovanni83 opened this issue Jul 26, 2023 · 0 comments
Open

Document Module Naming guidelines in the Docs #13

DonGiovanni83 opened this issue Jul 26, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation feature This Issue/PR relates to a feature request good first issue Good for newcomers

Comments

@DonGiovanni83
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As a developer, I need guidelines for naming the ansible modules in this collection in a consistent and intuitive manner, so that it is clear to developers as well as to users where to find certain features and functionalities of this collection.

Describe the solution you'd like
I suggest a Naming convention following the web UI menu structure. See Additional context for an example.

Describe alternatives you've considered
I have not considered alternative naming conventions, but I am open to suggestions. This convention must be documented in the doc site for developers.

Additional context
Let's take an example of a simple configuration. If we want to have a module that sets the hostname and domain of the firewall, I suggest naming that module system_settings_general because the hostname and domain would be configured in the menu at System>Settings>General as depicted in the following image:

web_ui

This for example could translate to this ansible module:

- name: set fw hostname
  puzzle.opnsense.system_settings_general:
    hostname: "fw01"
    domain: "test.local"
@DonGiovanni83 DonGiovanni83 added feature This Issue/PR relates to a feature request documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature This Issue/PR relates to a feature request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant