Tool: enforce file name to use kebab-case in documentation content #589
Comments
benjaminParisel
added a commit
to bonitasoft/actions
that referenced
this issue
Oct 8, 2024
* check if the filename follow the convention (kebab-case) * suggest a new filename to resolve the issue. Covers bonitasoft/bonita-documentation-site#589
This was referenced Oct 8, 2024
benjaminParisel
pushed a commit
to bonitasoft/bonita-labs-doc
that referenced
this issue
Oct 8, 2024
benjaminParisel
pushed a commit
to bonitasoft/bonita-doc
that referenced
this issue
Oct 8, 2024
This was referenced Oct 8, 2024
Closed
benjaminParisel
pushed a commit
to bonitasoft/bonita-cloud-doc
that referenced
this issue
Oct 14, 2024
This is the convention that must be followed. Additional changes - add missing description in the "index" page - fix AsciiDoc attributes declaration (must be right after the page title) - fix some typo in the "overview" page ### Notes Covers bonitasoft/bonita-documentation-site#589
benjaminParisel
pushed a commit
to bonitasoft/bonita-cloud-doc
that referenced
this issue
Oct 16, 2024
…65) Also fix typo and rendering. ### Notes Covers bonitasoft/bonita-documentation-site#589
This was referenced Oct 16, 2024
benjaminParisel
added a commit
to bonitasoft/bonita-cloud-doc
that referenced
this issue
Oct 18, 2024
* rename page and image to follow kebab-case convention * Organize pages with sub-folders * rename image * adding description and page aliases Covers bonitasoft/bonita-documentation-site#589
benjaminParisel
added a commit
that referenced
this issue
Oct 23, 2024
* Add workflow to check contribution on test content Cover #589
benjaminParisel
added a commit
that referenced
this issue
Oct 23, 2024
* based on feat/check_file_name branch from action repository ### Notes Validate bonitasoft/actions#138 and bonitasoft/actions#140 Cover #589
benjaminParisel
added a commit
to bonitasoft/bonita-continuous-delivery-doc
that referenced
this issue
Oct 23, 2024
* all Filename are actually didn't follow the convention And this documentation content is not update. That's why we want to skip the page-filename step on contribution check. Cover bonitasoft/bonita-documentation-site#589
benjaminParisel
added a commit
to bonitasoft/bonita-continuous-delivery-doc
that referenced
this issue
Oct 23, 2024
* all Filename are actually didn't follow the convention And this documentation content is not updated. That's why we want to skip the page-filename step on the contribution check. Cover bonitasoft/bonita-documentation-site#589
github-project-automation
bot
moved this from In Progress
to Done
in Bonita documentation site - work in progress
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
IMPORTANT: Be aware of #422
This is advised in the Contributing documentation (https://github.com/bonitasoft/bonita-documentation-site/blob/b681fad6558299ae8027a749aa11121837a23d99/docs/content/CONTRIBUTING.adoc#file-names) but a lot of resources don't follow them.
This should be check as part of the repository content checks.
This will apply only to the branches of supported versions of the documentation.
Fixing the document content repositories first
Prior pushing this feature the document content repositories must be fixed.
cloud and bcd prefix some pages by categories. This naming comes from the time the documentation site was using Markdown content and there was no easy way to use subfolders. Antora modules should be used
Tasks
bcd? No longer updated so we may not want to update this contentbpiNothing to docentralNothing to dorefactor: introduce modules and rename pages to follow kebab-case bonita-cloud-doc#62too large, will be splittest-toolkitNothing to dobonitasoft/actionsfirst. We need an input to disable the step in content repositories where the page names haven't been fixed yet. ci: check file name in the "antora guidelines" workflow #791The text was updated successfully, but these errors were encountered: