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

Tool: detect pages that are not in the navbar #590

Open tbouffard opened 1 year ago

tbouffard commented 1 year ago

IMPORTANT: Be aware of #422

All pages of a component version are supposed to be accessed publicly and should be part of the navbar.

The verification could be done as part of the repository content checks. Generally, all pages are expected to be in the navbar. Such tool would warn contributors when they miss a page. This can also occurred when a page is renamed and the navbar is not updated: https://github.com/bonitasoft/bonita-doc/pull/1749 See also https://documentation.bonitasoft.com/bonita/7.11/bonita-bpm-overview

The Antora extension tutorial described in details how to detect such pages: https://docs.antora.org/antora/3.1/extend/extension-tutorial/ and https://docs.antora.org/antora/3.1/extend/extension-use-cases/#report-unlisted-pages So, we could create an extension for such purpose.

Exceptions

In special situation, some pages are not put in the navbar on purpose. For instance, the bonita-doc dependencies pages. Such pages could be pass as an input/parameter (full path, glob, ...) to ignore them during the detection. Notice that such pages shouldn't be indexed as well as part of SEO (see #566) They are also currently available via the DocSearch page. If they shouldn't, create a specific issue.

Existing resources