search

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 don't include an AsciiDoc "description" attribute #591

Closed tbouffard closed 9 months ago

tbouffard commented 1 year ago

IMPORTANT: Be aware of #422

The attribute is needed to improve SEO and it is described as such in the contributing guide: https://github.com/bonitasoft/bonita-documentation-site/blob/b681fad6558299ae8027a749aa11121837a23d99/docs/content/CONTRIBUTING.adoc#contribution-check. The check could be done as part of the repository content checks. A lot of pages in the cloud repository don't declare the attribute.

benjaminParisel commented 10 months ago

First action has been created here: https://github.com/bonitasoft/actions/pull/115

In this PR, we added a "step" to validate if an attribute exist in updated file.

At same time, i added another step (to validate if multiple step work), it's the actual Forbidden Link action (actually it's the pr-diff-checker action). Now (with this new action) this check is done in the complete file updated, not only on the specific line updated.

benjaminParisel commented 10 months ago

We need to use this action in the following repositories and this must be done by using a reusable workflow (#422):