Skip to content

Docs Versioning #2552

@joepio

Description

@joepio

We willen dat bezoekers eenvoudig kunnen wisselen tussen API & Docs versies.

We gebruiken daarvoor versioning in Docusaurus.

Wat moet er niet geversioned worden?

  • Contact
  • Community

Hoe doen we de mapstructuur?

  • released bevat alle bronbestanden, per versie, die al eerder gepubliceerd zijn. Zowel API specs als documentaties. Geberuikers kunnen deze oudere versies kiezen via een dropdown selector in de navigatiebalk.
  • api_specs OpenAPI files. Hieronder zitten v1 (actieve, meest recente versie) en v2 (volgende versie, feedback nodig) mappen met docs.
  • docs ongeversioneerde documenten. Deze moeten altijd up to date skin.

How worden de released files aangemaakt?

  • Door gen-api-docs:version te draaien
  • Het liefst draait dit in de CI

to be continued

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions