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

Update environment variables page to also include plugins #144

Open
1 task done
samccann opened this issue Feb 17, 2022 · 5 comments
Open
1 task done

Update environment variables page to also include plugins #144

samccann opened this issue Feb 17, 2022 · 5 comments
Labels
doc builds Relates to building the documentation

Comments

@samccann
Copy link
Contributor

Summary

The current env vars page does not include plugins... We should update this autogenerated page to bring that detail in

https://docs.ansible.com/ansible/latest/reference_appendices/config.html#environment-variables

Issue Type

Documentation Report

Component Name

none

Ansible Version

$ ansible --version
none

Configuration

$ ansible-config dump --only-changed
none

OS / Environment

none

Additional Information

none

Code of Conduct

  • I agree to follow the Ansible Code of Conduct
@ansibot
Copy link
Contributor

ansibot commented Feb 17, 2022

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added the needs_triage Needs a first human triage before being processed. label Feb 17, 2022
@nitzmahone nitzmahone removed the needs_triage Needs a first human triage before being processed. label Feb 17, 2022
@samccann
Copy link
Contributor Author

A change to ansible-config has the plugin env vars and the script that generates this docs page needs to be updated to also now handle plugins:
ansible/ansible#49627

@bcoca
Copy link
Member

bcoca commented Jul 19, 2023

closing, should be moved to https://github.com/ansible/ansible-documentation/

@bcoca bcoca closed this as completed Jul 19, 2023
@Akasurde Akasurde reopened this Jul 19, 2023
@Akasurde Akasurde transferred this issue from ansible/ansible Jul 19, 2023
@felixfontein
Copy link
Collaborator

The page says, "Other environment variables to configure plugins in collections can be found in Index of all Collection Environment Variables.". The link goes to a page mentioning all environment variables defined by plugins (https://docs.ansible.com/ansible/latest/collections/environment_variables.html#list-of-collection-env-vars) that are not already mentioned on https://docs.ansible.com/ansible/latest/reference_appendices/config.html#environment-variables.

@bcoca
Copy link
Member

bcoca commented Jul 19, 2023

I would actually remove the current page(s) and document how ansible-config can dump files with 'ini', 'env vars' and 'yaml variables' for the configurations. Otherwise I would expect both ini and variable pages corresponding to the same.

@samccann samccann added the doc builds Relates to building the documentation label Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc builds Relates to building the documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

6 participants