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

Create documentation overview with all possible settings #276

Open
tyll opened this issue Aug 27, 2020 · 0 comments
Open

Create documentation overview with all possible settings #276

tyll opened this issue Aug 27, 2020 · 0 comments
Labels
help wanted Possible issue for newcomers medium effort estimated to require a medium effort

Comments

@tyll
Copy link
Member

tyll commented Aug 27, 2020

https://github.com/linux-system-roles/network/blob/main/scripts/print_all_options.py allows to create an overview of all settings the role accepts. Use this to create an overview (maybe in the appendix) of the documentation and integrate this into the CI to ensure that it is up to date. Ideally, the settings from the script would link to the part of the README that explains how to configure the setting.

@tyll tyll added help wanted Possible issue for newcomers medium effort estimated to require a medium effort labels Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Possible issue for newcomers medium effort estimated to require a medium effort
Projects
None yet
Development

No branches or pull requests

1 participant