-
Notifications
You must be signed in to change notification settings - Fork 667
add details on some plugin options - AI-assisted #2813
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
base: devel
Are you sure you want to change the base?
Conversation
Okay made the changes. Can you take another look @felixfontein ? |
Co-authored-by: Felix Fontein <[email protected]>
Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Felix Fontein <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides the following, LGTM
@@ -63,18 +63,67 @@ To define configurable options for your plugin, describe them in the ``DOCUMENTA | |||
description: describe this config option | |||
default: default value for this config option | |||
env: | |||
- name: NAME_OF_ENV_VAR | |||
- name: MYCOLLECTION_NAME_OF_ENV_VAR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- name: MYCOLLECTION_NAME_OF_ENV_VAR | |
- name: MYCOLLECTION_NAME_ENV_VAR_NAME |
could it be something like that? it's not much longer.
MYCOLLECTION_NAME_OF_ENV_VAR
sounds a bit confusing to me, especially the OF
part.
If as-is is crystal clear for everyone else, please ignore the suggestion.
Same for ini and vars items.
* Keywords | ||
* CLI settings | ||
* Environment variables | ||
* Values defined in ``ansible.cfg`` | ||
* Default value for the option, if present. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Keywords | |
* CLI settings | |
* Environment variables | |
* Values defined in ``ansible.cfg`` | |
* Default value for the option, if present. | |
* Keywords | |
* CLI settings | |
* Environment variables (``env``) | |
* Values defined in ``ansible.cfg`` | |
* Default value for the option, if present. |
should we mention in brackets or anyhow the sources for each item not to make people match in heads?
Fixes #2673
Should have done this in 2 commits (AI-generated, then human adapted). Lines 78-93 are predominantly generated.
To fix this bug, I fed the following into Cursor chat mode:
Fix the documentation problems from @https://github.com/ansible/ansible-documentation/issues/2673