Skip to content

v1.13.0

Choose a tag to compare

@andrepasteur andrepasteur released this 29 Jul 15:47
· 288 commits to main since this release

New features

  • (antora-extension) Add the possibility to check for updates of osc-doc-framework: 5dd8d92...b873a85
    • Explanation: If the below keys are specified in the Antora playbook, osc-doc-framework will check for updates when the antora generate command is run. If there is an update available, the generation will be stopped so that the user can update the framework. If there is no update available, the generation happens normally.
      antora:
          extensions:
              - require: ./node_modules/@outscale/osc-doc-framework/antora-extension
              update_checker: true
  • (antora-extension) In the generated API docs, add the possibility to tag API calls or API parameters as "Deprecated" 571278c...8363216, b50fd05...e15d613, b3f3ae7
    • Explanation: In the OpenAPI definition of an API, if the string Deprecated: appears in the description of an API call or the description of an API parameter, the call or parameter will be visually marked as "Deprecated" in the generated API docs.

Improvements

  • (Vale) Updated the Vale rules: e15d613...67c4331
    • (Vale) Added the rules for the new Release Note format
    • (Vale) Added a rule for bad monospace format

Bugfixes

  • (antora-extension) In the generated OSC CLI sections (Antora partials), fix missing subparameters 571278c
  • (antora-theme) Fix various CSS bugs