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 #210

Open
2 tasks
stevenbal opened this issue Dec 19, 2024 · 0 comments · May be fixed by #228
Open
2 tasks

Rewrite setup_configuration documentation #210

stevenbal opened this issue Dec 19, 2024 · 0 comments · May be fixed by #228
Assignees
@stevenbal
Labels
documentation Improvements or additions to documentation owner: dimpact topic: setup-config
Milestone
Release 1.9.0

Comments

@stevenbal
Copy link
Contributor

stevenbal commented Dec 19, 2024 •
edited
Loading

To make sure it's clear how to connect to autorisaties API (described here https://open-notificaties.readthedocs.io/en/1.7.1/installation/configuration/opennotifs_config_cli.html)

And to give examples of the YAML format

  • Add link to general documentation (see OF implementation)
  • Use example sphinx directive + autodoc
@stevenbal stevenbal added documentation Improvements or additions to documentation topic: setup-config labels Dec 19, 2024
@stevenbal stevenbal self-assigned this Dec 19, 2024
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
📌 [#210] Pin django-setup-configuration to branch
9738c9e
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
⬆️ [#210] Upgrade mozilla-django-oidc-db to 0.22.0
fce6ecd
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
⬆️ [#210] Upgrade zgw-consumers to 0.37.0
9ca2963
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
dc679af 
with general info on how to use the command, as well as YAML examples per configuration step
@stevenbal stevenbal moved this from Todo to In Progress in Data en API fundament Jan 31, 2025
@stevenbal stevenbal linked a pull request Jan 31, 2025 that will close this issue
Open
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
📌 [#210] Pin commonground-api-common to branch
7665fa2
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
📌 [#210] Pin notifications-api-common to branch
e64cbc9
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
d7a847d 
with general info on how to use the command, as well as YAML examples per configuration step
stevenbal added a commit that referenced this issue Jan 31, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
40705d4 
with general info on how to use the command, as well as YAML examples per configuration step
stevenbal added a commit that referenced this issue Feb 6, 2025
@stevenbal
⬆️ [#210] Upgrade django-setup-configuration to 0.7.0
f0fe39f
stevenbal added a commit that referenced this issue Feb 6, 2025
@stevenbal
⬆️ [#210] Upgrade mozilla-django-oidc-db to 0.22.0
df0465f
stevenbal added a commit that referenced this issue Feb 6, 2025
@stevenbal
⬆️ [#210] Upgrade zgw-consumers to 0.37.0
e6277df
stevenbal added a commit that referenced this issue Feb 6, 2025
@stevenbal
⬆️ [#210] Upgrade commonground-api-common to 2.5.0 and notifications-…
fb47e02 
…api-common to 0.6.0
stevenbal added a commit that referenced this issue Feb 6, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
805d2ab 
with general info on how to use the command, as well as YAML examples per configuration step
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
e14aed9 
with general info on how to use the command, as well as YAML examples per configuration step
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
646b8a8 
with general info on how to use the command, as well as YAML examples per configuration step
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
9a9fd16 
with general info on how to use the command, as well as YAML examples per configuration step

also adds more specific examples for some steps and put the steps in a more logical order
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
9cbe27f 
with general info on how to use the command, as well as YAML examples per configuration step

also adds more specific examples for some steps and put the steps in a more logical order
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
💬 [#210] Re-generate translations
93b4c74
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
💬 [#210] Add English translations for field names/help texts
28c8a9d 
to make sure we can render the setup configuration examples in English
stevenbal added a commit that referenced this issue Feb 7, 2025
@stevenbal
💬 [#210] Add English translations for field names/help texts
3db306a 
to make sure we can render the setup configuration examples in English
@stevenbal stevenbal moved this from In Progress to Implemented in Data en API fundament Feb 7, 2025
@stevenbal stevenbal added this to the Release 1.9.0 milestone Feb 10, 2025
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
⬆️ [#210] Upgrade django-setup-configuration to 0.7.1
19069e5
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
⬆️ [#210] Upgrade mozilla-django-oidc-db to 0.22.0
0601e4c
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
⬆️ [#210] Upgrade zgw-consumers to 0.37.0
0dc1193
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
⬆️ [#210] Upgrade commonground-api-common to 2.5.0 and notifications-…
95b5861 
…api-common to 0.6.0
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
📝 [#210] Update documentation for setup-configuration
248e49a 
with general info on how to use the command, as well as YAML examples per configuration step

also adds more specific examples for some steps and put the steps in a more logical order
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
💬 [#210] Re-generate translations
a8cd67d
stevenbal added a commit that referenced this issue Feb 10, 2025
@stevenbal
💬 [#210] Add English translations for field names/help texts
e75a7a1 
to make sure we can render the setup configuration examples in English
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
None yet
Milestone
Release 1.9.0
Development

Successfully merging a pull request may close this issue.

📝 [#210] Update documentation for setup-configuration open-zaak/open-notificaties
1 participant
@stevenbal