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

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
Labels
documentation Improvements or additions to documentation owner: dimpact topic: setup-config

Comments

@stevenbal
Copy link
Contributor

stevenbal commented Dec 19, 2024

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
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
8 tasks
stevenbal added a commit that referenced this issue Jan 31, 2025
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
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 added a commit that referenced this issue Feb 6, 2025
with general info on how to use the command, as well as YAML examples per configuration step
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation owner: dimpact topic: setup-config
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant