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

✨[#64] add subgroup to generate_envvar_docs #71

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Coperh
Copy link
Contributor

@Coperh Coperh commented Sep 17, 2024

Fixes #64

@Coperh Coperh force-pushed the feature/64-setup-config-envvars branch 2 times, most recently from 98ce9a5 to 6b932fe Compare September 17, 2024 14:05
@Coperh Coperh marked this pull request as ready for review September 17, 2024 14:32
@Coperh Coperh requested review from SonnyBA and stevenbal September 17, 2024 14:32
@Coperh
Copy link
Contributor Author

Coperh commented Sep 17, 2024

Do you think this is fine or should I try to implement the automatic help text retriever from setup config?

Not sure how this would be possible since envvars are not linked to the setup steps.
Maybe iterate through each step and each variable and check if that variable is found in the envvars.

Copy link
Contributor

@stevenbal stevenbal left a comment

Choose a reason for hiding this comment

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

Looks good, tested it briefly with Open Klant and it works.

The only thing I'm not sure about is how we fit in the general documentation about setup configuration. The current docs for OZ for example describe how the command can be used and also has one or two sentences to describe what each step does: https://github.com/open-zaak/open-zaak/blob/main/docs/installation/config/openzaak_config_cli.rst#open-zaak-configuration-cli.

I'm not sure if grouping setup-configuration envvars together with all the other environment vars is the right way to go, also because the former are more of a one time thing to set things up, while the "regular" envvars can be modified to directly change configuration.

@annashamray what do you think?

@Coperh Coperh force-pushed the feature/64-setup-config-envvars branch 5 times, most recently from a91a8ae to a35a001 Compare October 2, 2024 15:35
@Coperh Coperh force-pushed the feature/64-setup-config-envvars branch from a35a001 to c8eb4db Compare October 2, 2024 15:43
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.

Investigate what needs to be done to have documentation generation for setup-configuration
2 participants