bonitasoft / bonita-documentation-site

The sources of the Bonita Documentation site
https://documentation.bonitasoft.com/
GNU General Public License v2.0
9 stars 5 forks source link

Provide an ascidoc attribute 'page-hide-components' to hide a list of components #689

Closed benjaminParisel closed 3 months ago

benjaminParisel commented 3 months ago

To depreciate slowly a component listed in documentation site, we need sometime to hide an entry menu . We would like to hide one or more components in a specific couple component/version.

We want to stay the more generic as we can, so we imagine to declare an AsciiDoc attribute in the component descriptor file like:

asciidoc:
  attributes:
    page-hide-components: bcd, labs

:information_source: Put a list of component keys to be able to hide multiple entries.

benjaminParisel commented 3 months ago

To use this new feature, we need to add in the antora.yml file:

asciidoc: attributes: page-hide-components: bcd, labs

In page-hide-components, the input waits a component key separated by a comma character.