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

Investigate what needs to be done to have documentation generation for setup-configuration #64

Open
stevenbal opened this issue Aug 23, 2024 · 5 comments · May be fixed by #71
Open

Investigate what needs to be done to have documentation generation for setup-configuration #64

stevenbal opened this issue Aug 23, 2024 · 5 comments · May be fixed by #71
Assignees
Labels
blocked Issue is blocked. There should be a comment that explains why. documentation Improvements or additions to documentation owner: dimpact

Comments

@stevenbal
Copy link
Contributor

From maykinmedia/objects-api#425 (comment)

This might already be implemented through Paul's work (maykinmedia/django-setup-configuration#9), we just need to check what needs to be done in our projects to make use of this, I think

@stevenbal stevenbal added documentation Improvements or additions to documentation triage Triage means the team has not yet refined this issue. labels Aug 23, 2024
@joeribekker
Copy link
Member

refinement: this ticket is about the envvars but specifically about those in setup_configuration (which are not included yet in the PRs). These envvars should be part of the same documentation page but grouped/subgrouped per step.

We probably wont use Pauls work because that would mean 2 commands = 2 pages. I'm opting to remove Pauls command in that case.

Estimate: 1-2 weeks.

@joeribekker
Copy link
Member

This is part of the Dimpact CI/CD quote.

@joeribekker joeribekker removed the triage Triage means the team has not yet refined this issue. label Sep 3, 2024
@joeribekker joeribekker moved this from Triage to Todo in Data en API fundament Sep 3, 2024
@Coperh Coperh linked a pull request Sep 17, 2024 that will close this issue
Coperh added a commit that referenced this issue Sep 17, 2024
@stevenbal
Copy link
Contributor Author

@joeribekker I'm not sure if removing the existing command is the right thing to do, that implementation does some useful stuff like taking help texts from model fields (to not have to duplicate all that). The configuration steps in Open Inwoner map a lot of settings directly to model fields

@joeribekker
Copy link
Member

Refinement: Team decided to leave both commands in place and also keep the envvars in separate files.

Coperh added a commit that referenced this issue Oct 1, 2024
Coperh added a commit that referenced this issue Oct 2, 2024
Coperh added a commit that referenced this issue Oct 2, 2024
Coperh added a commit that referenced this issue Oct 2, 2024
Coperh added a commit that referenced this issue Oct 2, 2024
Coperh added a commit that referenced this issue Oct 2, 2024
Coperh added a commit that referenced this issue Oct 2, 2024
@Coperh Coperh added the blocked Issue is blocked. There should be a comment that explains why. label Nov 8, 2024
@Coperh
Copy link
Contributor

Coperh commented Nov 8, 2024

Blocked: waiting for Setup Configuration changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Issue is blocked. There should be a comment that explains why. documentation Improvements or additions to documentation owner: dimpact
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

3 participants