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.

Sign up for GitHub

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

Jump to bottom

Rewrite setup_configuration documentation with YAML example directive #521

Open
stevenbal opened this issue Jan 27, 2025 · 0 comments · May be fixed by #527
Open

Rewrite setup_configuration documentation with YAML example directive #521

stevenbal opened this issue Jan 27, 2025 · 0 comments · May be fixed by #527
Assignees
@stevenbal
Labels
documentation Improvements or additions to documentation owner: dimpact topic: setup-config
Milestone
Objects API relea...

Comments

@stevenbal
Copy link
Collaborator

stevenbal commented Jan 27, 2025 •
edited
Loading

Use the setup-config-usage directive (https://django-setup-configuration.readthedocs.io/en/latest/config_docs.html#using-setup-config-usage) to document the configuration steps

Since objecttypes does not have it's own docs page, the steps should probably be added manually using setup-config-example (on a separate page?)
@stevenbal stevenbal added documentation Improvements or additions to documentation owner: dimpact topic: setup-config labels Jan 27, 2025
@stevenbal stevenbal self-assigned this Feb 11, 2025
@stevenbal stevenbal moved this from Todo to In Progress in Data en API fundament Feb 11, 2025
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
⬆️ [#521] Upgrade django-setup-configuration to 0.7.1
4a69c6b
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
⬆️ [#521] Upgrade zgw-consumers to 0.37.0
93ae668
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
⬆️ [#521] Upgrade notifications-api-common to 0.6.0
76c7fcc
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
⬆️ [#521] Upgrade mozilla-django-oidc-db to 0.22.0
4bd9dbc
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
📝 [#521] Update docs for setup-config
4843d87
@stevenbal stevenbal linked a pull request Feb 17, 2025 that will close this issue
Open
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
👽 [#521] Fix ObjectsKanaal.get_kenmerken for new lib version
a154e1b 
get_kenmerken now has a request argument
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
✅ [#521] Fix tests for changed setup-configuration behavior
a720033 
changes are now rolled back on failure in a step, so some assertions were no longer correct
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
🔧 [#521] Install gdal packages in readthedocs build
a834de0 
because django.setup is run when building documentation now, we need to have these packages installed as well because we use postgis
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
📝 [#521] Update docs for setup-config
0051a54
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
👽 [#521] Fix ObjectsKanaal.get_kenmerken for new lib version
3789fbe 
get_kenmerken now has a request argument
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
✅ [#521] Fix tests for changed setup-configuration behavior
7157ef6 
changes are now rolled back on failure in a step, so some assertions were no longer correct
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
🔧 [#521] Install gdal packages in readthedocs build
1d26001 
because django.setup is run when building documentation now, we need to have these packages installed as well because we use postgis
@stevenbal stevenbal moved this from In Progress to Implemented in Data en API fundament Feb 17, 2025
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
📝 [#521] Update docs for setup-config
1f3ad75
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
👽 [#521] Fix ObjectsKanaal.get_kenmerken for new lib version
438a9df 
get_kenmerken now has a request argument
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
✅ [#521] Fix tests for changed setup-configuration behavior
d6d0022 
changes are now rolled back on failure in a step, so some assertions were no longer correct
stevenbal added a commit that referenced this issue Feb 17, 2025
@stevenbal
🔧 [#521] Install gdal packages in readthedocs build
9117045 
because django.setup is run when building documentation now, we need to have these packages installed as well because we use postgis
@stevenbal stevenbal added this to the Objects API release 3.1.0 milestone Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stevenbal stevenbal

Labels
documentation Improvements or additions to documentation owner: dimpact topic: setup-config
Projects
Data en API fundament
Status: Implemented
Milestone
Objects API release 3.1.0
Development

Successfully merging a pull request may close this issue.

📝 [#521] Update docs for setup-config maykinmedia/objects-api
1 participant
@stevenbal