Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tool: detect pages that don't include an AsciiDoc "description" attribute #591

Closed
tbouffard opened this issue Jun 30, 2023 · 2 comments
Closed

Tool: detect pages that don't include an AsciiDoc "description" attribute #591

tbouffard opened this issue Jun 30, 2023 · 2 comments
Assignees
@benjaminParisel
Labels
CI ⚙️ SEO

Comments

@tbouffard
Copy link
Member

tbouffard commented Jun 30, 2023 •
edited
Loading

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 benjaminParisel self-assigned this Jul 7, 2023
@benjaminParisel
Copy link
Contributor

First action has been created here: bonitasoft/actions#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 benjaminParisel mentioned this issue Oct 19, 2023
Merged
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Oct 19, 2023
@benjaminParisel
chore: use a new action to better check the contribution content (#2480)
eec8746 
Use new action to validate if contribution (PR) follows the guidelines
on documentation content

For now only check if: 
* files contain:description: attributes
* files not contain any forbidden attribute

Covers
bonitasoft/bonita-documentation-site#591
@benjaminParisel
Copy link
Contributor

benjaminParisel commented Oct 19, 2023 •
edited by tbouffard
Loading

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

benjaminParisel added a commit to bonitasoft/bonita-cloud-doc that referenced this issue Oct 19, 2023
@benjaminParisel
chore: use a new action to better check the contribution content
2eae0fb 
Use new action to validate if contribution (PR) follows the guidelines on documentation content

For now only check if:

files contain:description: attributes
files not contain any forbidden attribute

Covers bonitasoft/bonita-documentation-site#591
@benjaminParisel benjaminParisel mentioned this issue Oct 19, 2023
Merged
benjaminParisel added a commit to bonitasoft/bonita-continuous-delivery-doc that referenced this issue Oct 19, 2023
@benjaminParisel
chore: use a new action to better check the contribution content
e3a1bfd 
Use new action to validate if contribution (PR) follows the guidelines on documentation content

For now only check if:
files contain:description: attributes
files not contain any forbidden attribute

Covers bonitasoft/bonita-documentation-site#591
@benjaminParisel benjaminParisel mentioned this issue Oct 19, 2023
Closed
benjaminParisel added a commit to bonitasoft/bonita-labs-doc that referenced this issue Oct 19, 2023
@benjaminParisel
chore: use a new action to better check the contribution content
7e708e4 
Use new action to validate if contribution (PR) follows the guidelines on documentation content

For now only check if:
files contain:description: attributes
files not contain any forbidden attribute

Covers bonitasoft/bonita-documentation-site#591
@benjaminParisel benjaminParisel mentioned this issue Oct 19, 2023
Merged
@tbouffard tbouffard mentioned this issue Nov 17, 2023
Closed
13 tasks
benjaminParisel added a commit to bonitasoft/bonita-labs-doc that referenced this issue Nov 24, 2023
@benjaminParisel
chore: use a new action to better check the contribution content (#149)
c7430b0 
Use the new use reusable workflow to validate if the contribution (PR) follows the guidelines on documentation content

For now only check if:
- files contain:description: attributes
- files not contain any forbidden attribute

Covers bonitasoft/bonita-documentation-site#591
Covers bonitasoft/bonita-documentation-site#422
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Nov 24, 2023
@benjaminParisel
ci: Use reusable workflow for contribution checks
2a6f609 
Covers bonitasoft/bonita-documentation-site#591
@benjaminParisel benjaminParisel mentioned this issue Nov 24, 2023
Merged
benjaminParisel added a commit to bonitasoft/bonita-continuous-delivery-doc that referenced this issue Nov 24, 2023
@benjaminParisel
chore: use a new action to better check the contribution content
3ed883b 
Use new action to validate if contribution (PR) follows the guidelines on documentation content

For now only check if:
files contain:description: attributes
files not contain any forbidden attribute

Covers bonitasoft/bonita-documentation-site#591
@benjaminParisel benjaminParisel mentioned this issue Nov 24, 2023
Merged
benjaminParisel added a commit to bonitasoft/bonita-test-toolkit-doc that referenced this issue Nov 24, 2023
@benjaminParisel
chore: use a new action to better check the contribution content
a492cad 
Use new action to validate if contribution (PR) follows the guidelines on documentation content

For now only check if:
files contain:description: attributes
files not contain any forbidden attribute

Covers bonitasoft/bonita-documentation-site#591
@benjaminParisel benjaminParisel mentioned this issue Nov 24, 2023
Merged
benjaminParisel added a commit to bonitasoft/bonita-central-doc that referenced this issue Nov 24, 2023
@benjaminParisel
ci: use a new action to better check the contribution content
7bb1c10 
Use new action to validate if contribution (PR) follows the guidelines on documentation content

For now only check if:
* files contain :description: attributes
* files not contain any forbidden attributes

Covers bonitasoft/bonita-documentation-site#591
Covers bonitasoft/bonita-documentation-site#422
@benjaminParisel benjaminParisel mentioned this issue Nov 24, 2023
Merged
@tbouffard tbouffard mentioned this issue Feb 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@benjaminParisel benjaminParisel

Labels
CI ⚙️ SEO
Projects
Bonita documentation site - work in progress
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@benjaminParisel @tbouffard