Skip to content

CHANGELOG.md

Latest commit

 

History

History
363 lines (238 loc) · 28.3 KB

CHANGELOG.md

File metadata and controls

363 lines (238 loc) · 28.3 KB

osc-doc-framework Changelog

1.18.0 (2025-07-17)

New features

  • End-user features:
    • (antora-extension) In API docs, automatically append the descriptions with pieces of info gathered from the following JSON Schema keywords, if these pieces of info are specified in the OpenAPI source documents: minItems/maxItems, minLength/maxLength, pattern, multipleOf, minimum/maximum, exclusiveMinimum/exclusiveMaximum, enum, default, example/examples, and const 758fe2e, 3c28559...73b4a16, fd2b182, 166a552
    • (antora-ui) Adapt the print CSS of the API docs so that API docs can be exported to PDF in a pretty layout ed64599
    • (antora-ui) Enhance the appearance of the navigation tree by highlighting the parent pages of the active page, instead of just the active page 61daf6f
  • Authoring/CI-centric features:

Improvements

  • (antora-extension / antora-ui) UI improvements:
    • In API docs, move contact info and terms of service info from below the intro text to below the page title 166a552
    • In API docs, rename "Shell" tab to "Curl" 0a82bc0...46ec86d
    • In API docs, add vertical padding at the bottom of the left panel to prevent the last item of the list from being hidden by the browser's URL text pop-up 450944c
    • In the User Guide's search results list, add a small message to inform of the possibility to press Enter to access the standalone search results page 0a82bc0
  • (Vale) Update Vale rules, to detect curved quotes, code blocks that should be JSON, and some term exceptions 9973890...5d97239

Bugfixes

1.17.1 (2024-12-02)

Bugfixes

  • (antora-extension) Fix bug in update-checker.js a2e5255
  • (antora-extension / widdershins) Fix regression in terminal prompt display 46464f5
  • (antora-extension / widdershins) Fix default value for server/endpoint f6c769d
  • (antora-extension / widdershins) Prevent infinite loop when API has recursive schemas 86792df
  • (antora-extension / widdershins) Fix query string syntax in HTTP code samples f347cfb

1.17.0 (2024-11-22)

New features

  • Updated the README.adoc with a link to a demo repository 4d5a5de
  • (antora-extension / widdershins) Allow shins-templates and widdershins-templates to be overridden 23d5467

Improvements

  • (antora-extension / widdershins) Updated the API DOC generation scripts:
  • (Vale) Updated some rules 8085238, 59f056a

Bugfixes

  • (antora-extension / widdershins) Fix display of empty response bodies c4adbe5
  • (antora-extension / widdershins) Don't omit the nested parameters of repeated objects b5488b0
  • (antora-extension / widdershins) Don't omit request body schemas in Schemas section 596d4ae

1.16.0 (2024-11-13)

Improvements

  • General refactoring: 3eeca90
    • (antora-theme) Instead of supplementing the Antora Default UI, osc-doc-framework now directly builds a full UI package during doc generation
      • You can use this full UI package by modifying your playbook file as follows: 
        ui:
  bundle:
    url: ./node_modules/@outscale/osc-doc-framework/antora-ui/build/ui-bundle.zip
    snapshot: true
    • (antora-extension / widdershins) Separate Widdershins scripts from template files
    • (antora-extension) Improve generation of API docs, by making it executable by Node instead of just sh
    • (antora-extension) Merge asciidoctor-extensions back into antora-extension in order to make the AWS disclaimer code more customizable
    • Updated the README.adoc file and copied the GitHub release note entries into a CHANGELOG.md file

Bugfixes

  • (antora-extension / widdershins) Fix bugs in API doc generation 7a01777, c76455e

1.15.0 (2024-11-05)

New features

  • (antora-extension) Add code examples generation for oapi-cli 3039f66
  • (antora-extension) Add correspondences between oAPI calls and Terraform resources/data sources 0189721

Improvements

  • (Vale) Added exceptions in TitleCaps.yml rule 2d936aa
  • (Vale) Improved MergeConflicts.yml rule 4ff5772

Bugfixes

  • (antora-extension / antora-theme / antora-tooltipper-extension) Various bugfixes

1.14.0 (2024-09-20)

New features

  • (antora-extension) The layout of the API documentation has been improved: c33054e
    • Nested request parameters and nested response elements are now indicated by vertical lines and nodes, instead of indent symbols (») previously.
    • In the response part of each method, the response 200 elements are now directly listed, instead of only having a link to the response schema.
    • When there are more than one examples for a response, the first example is visible by default while the other examples are enclosed in expandable blocks.
  • (antora-tooltipper-extension) There are now tooltips in the API DOCs too 3a18bad, 8a2a3ec
  • (antora-theme) In the EIM Policy Generator, you can now select a "NotAction" option ca4d733
  • (Vale) Vale now also runs on the CSV files of the API DOCs 4baa86e, 0777e38

Improvements

  • (antora-extension) Made the links to API DOCs relative instead of absolute e6ab48a
  • (antora-extension) Made all external links open in a new tab 909b81c
  • (antora-theme) Improved the EIM Policy Generator:
    • Made sure that "All Read actions" also captures Get/Describe/List actions f538364
    • Added error if policy exceeds max length 2714dbd
  • (Vale) Updated some Vale rules e0848f3, 433037a

Bugfixes

  • (antora-extension) API DOC refactoring + Fixed the scrolling when accessing the API DOCs from anchor links 8f772b7, 8d394b0, e8c22fc, 40e5316, e19f958, b1bf394
  • (antora-extension) Fixed SSH bug in osc-doc-framework update checker 54560d4
  • (antora-rss-extension) Fixed relative links in generated RSS feeds 365677d

1.13.0 (2024-29-07)

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

1.12.1 (2024-06-19)

Bugfixes

  • (antora-special-pages-extension) Make the release notes page more responsive/mobile-friendly: 8e020b3
  • (antora-special-pages-extension) Remove the HTML IDs from the h3-h6 headings of the release notes (to avoid old RSS entries from changing when new entries with similar headings are created): 77fbc9b

1.12.0 (2024-06-18)

New features

Improvements

  • (antora-theme) Modify the CSS of collapsible blocks: c1aa13c, ba12f14
  • (antora-theme) Disable the tooltip explanation box that was at the top right of pages: 0208dc0

Bugfixes

  • (antora-theme) In the EIM Policy Generator, fix incorrect extra spaces in the JSON string output: 6040126
  • (antora-theme) Make Matomo integration more compatible with Content Security Policy: e7bf966
  • (antora-extension) Fix various bugs in the API doc generator
  • (antora-theme) Fix various CSS bugs

1.11.0 (2024-04-26)

New features

  • (antora-theme) The terminal prompt ($) is no longer selectable in code blocks
  • (antora-theme) Table columns can now be sorted, thanks to cpkio/JSTable plugin
  • (antora-theme) The EIM Policy Generator now also outputs its result as a JSON string
  • (antora-special-pages-extension / antora-theme) Revamped the 404 page

Improvements

  • (Vale) Improved the TitleCaps.yml rule and the Harmonization.yml rule

1.10.0 (2024-04-11)

New features

  • (Vale) Updated the Vale rules:
    • (Vale) Added rule to prevent linking to timesensitive URLs
    • (Vale) Added rule to prevent Shell format in code block response samples.
    • (Vale) Added more terms, phrasings, and anglicisms to avoid.
    • (Vale) Fixed the FR title capitalization rule.
  • (antora-extension) The script for merging the text descriptions into the API YAML now adds the names of any missing descriptions in the generated API DOC page (next to the NOT_FOUND mentions).

Bugfixes

  • (antora-theme) Fixed various CSS bugs that appeared following the implementation of the new corporate visual theme

1.9.0 (2024-03-15)

New features

  • (antora-theme) Implement new corporate visual theme (charte graphique)
  • (antora-extension) API docs are now generated directly from Antora
  • (antora-extension) Make the detection of errors in API examples possible via an environment variable (OPENAPI_EXAMPLES_VALIDATOR)

Bugfixes

  • (antora-extension / widdershins) Fix display of "nullable" API parameters
  • (antora-theme) Fix slowdown when changing code sample language in API docs
  • (antora-theme) Fix various CSS bugs

1.8.0 (2024-02-19)

New features

Bugfixes

  • (antora-extension / widdershins) Fix format of JSON strings in API examples
  • (antora-extension / widdershins) Fix display of "OneOf" API parameters
  • (antora-theme) Fix link on top-left Outscale logo

1.7.0 (2024-01-22)

New features

  • (antora-extension) osc-doc-framework can now generate API documentation by using a combination of Widdershins, Shins, Antora Collector Extension, and custom scripts. (To be documented.)
  • (antora-extension) osc-doc-framework can now generate a custom 404 page. (Not yet in production on docs.outscale.com.)

Bugfixes

  • (antora-theme) Various UI adjustments

1.6.0 (2023-12-14)

New features

  • (antora-git-log-extension) Add antora-git-log-extension to insert "Page modified on" timestamps in pages

Improvements

  • (Vale) Improve rule to avoid multiple :page-aliases: invocations
  • (Vale) Improve rule to detect bad xref formats
  • (Vale) Add rule to detect bad include formats

Minor changes

  • (antora-theme) Modify Zendesk widget integration and Matomo integration for cookie compliance

Bugfixes

  • (antora-theme) Fixed various minor CSS issues

1.5.1 (2023-11-24)

Improvements

  • (antora-theme) Fix inability to click links in dropdown menus of the top menu bar.

1.5.0 (2023-11-24)

New features

  • (antora-theme) Added ability to integrate Matomo (disabled by default). 9fda0cf

Improvements

  • (antora-theme) Reworked the top menu bar to make it more responsive (removal of a jQuery dependency) and more customizable (ability to specify the menu entries in Antora configuration rather than them being hardcoded). 7fe9121

1.4.0 (2023-10-26)

New features

  • (antora-theme) In the top menu bar, added a link to the AWS Compatibility Matrix page.
  • (antora-extension) Broken links are now detected in :page-fr: and :page-en: Antora attributes, like normal xref: links.
  • (Vale) Added a rule to detect bad date formats in the release notes pages.
  • (Vale) Added some cryptography-related exceptions in the spellcheck rule.

Minor changes

  • (antora-theme) Changed "Cockpit v2-beta" to "Cockpit v2" in the top-right green box.

Bugfixes

  • (antora-theme) In tables that are very wide horizontally, such as VM Types, the text in the rightmost column can now be selected normally.
  • (antora-theme) A line break is now added before all the autogenerated AWS disclaimers in order to avoid some visual bug.

1.3.0 (2023-09-06)

New features

  • (Vale) Added new rules:
    • If the page contains at least one section, you don't need to use the preamble formatting.
    • In a list of more than two items, use the serial comma (, and, , or).
    • Shell code blocks must start with a prompt ($ ).
    • If a sentence ends with an xref link, don't forget to put a period at the end.

Improvements

  • (Vale) Improved some existing rules:
    • Improved the Spelling and TitleCaps rules with more exceptions. Also removed the Vocab folder as it was confusing these rules (exceptions are now directly listed in these rules).
    • Improved the BulletSyntax and SpaceColon rules. When they detect an error, they now highlight the whole first word or the whole sentence, respectively.
    • Improved the XrefSyntax rule.
  • (antora-theme) The footer of the generated site now contains a link to this repo.

Bugfixes

  • (antora-theme) When accessing a section via an anchor link, the top menu bar no longer hides the section title.

1.2.0 (2023-07-27)

New features

  • (antora-extension / antora-theme) Add search page feature
  • (antora-theme) Make it possible to export pages to PDF

Minor changes

  • (antora-theme) Tooltips no longer start with an uppercase letter (unless the term is actually capitalized)

1.1.0 (2023-07-07)

New features

  • (Vale) Add English spellcheck and new rules
  • (Vale) Improve Vale's output style
  • (antora-theme) Add favicon
  • (antora-theme) Make table headers sticky when scrolling

Bugfixes

  • (antora-extension) Use MacOS system certificates if necessary
  • (antora-extension) Allow CI to access private repos

1.0.1 (2023-03-21)

  • Bugfixes

1.0.0 (2023-03-15)

  • First general release

0.0.0 (2023-03-03)

  • First version