API documentation

[pgaetani]

https://admin.test.notifynl.nl/using-notify/api-documentation
Link to our forks for client libraries
Link to our rest API documentation endpoint, so its in sync with the version we run.

[pgaetani]

Copies of docs found in https://github.com/alphagov/notifications-tech-docs needs to be added to gitbook and re-linked in api-documentation.html template.

[pgaetani]

Things that need to happen regardless:

• Fork of the notifications-tech-docs repo.
• Modifications to that repo to reflect how to point the client creation (in every language) to the NotifyNL endpoints.

Workable scenario:

• Those docs are built and published as they are, requiring a new domain for them to live in, meaning either:
  • They are built into a container image that then lives with the rest of the notifynl apps or,
  • They are somehow hosted on github using the gh-pages function.

Ideal scenario:

• The docs are rendered into markdown which can then be included in the gitbook we already host.

[pgaetani]

The tech docs repo is using Middleman as a site builder, which looks to have markdown options for its template engine. A lot of the templates in the repo seem to be markdown already as well, so perhaps just some finagling of the config.rb file is needed.

[pgaetani]

We have since been using gitbook. So links to the appropriate places need to be double-checked.