update comments

bonitasoft · Oct 7, 2024 · d74930a · d74930a
1 parent c41ab94
commit d74930a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/packages/doc-contribs/pr-antora-content-guidelines-checker/dist/index.js b/packages/doc-contribs/pr-antora-content-guidelines-checker/dist/index.js
@@ -29720,9 +29720,11 @@ class PageFilenameStep extends validation_1.ValidationStep {
         let commentBody = `## 🥙 ${this.name} \n`;
         commentBody += `${this.description}\n`;
         this.stepResult.results.forEach((actionResult) => {
-            commentBody += `- [ ] Rename **${actionResult.file}** to **${actionResult.file}**\n`;
+            commentBody += `- [ ] Rename **${actionResult.file}** to **${actionResult.details}**\n`;
         });
-        commentBody += `\n \n Additionally, don't forget to add the \`:page-aliases:\` attribute after renaming the files to avoid broken links or references.`;
+        commentBody += `
+> [!warning]
+> Additionally, don't forget to add the \`:page-aliases:\` attribute after renaming the **existing files** to avoid broken links or references. `;
         return commentBody;
     }
     toKebabCase(str) {

diff --git a/packages/doc-contribs/pr-antora-content-guidelines-checker/dist/index.js.map b/packages/doc-contribs/pr-antora-content-guidelines-checker/dist/index.js.map
diff --git a/packages/doc-contribs/pr-antora-content-guidelines-checker/src/steps/PageFilenameStep.ts b/packages/doc-contribs/pr-antora-content-guidelines-checker/src/steps/PageFilenameStep.ts
@@ -32,10 +32,11 @@ export class PageFilenameStep extends ValidationStep {
     let commentBody = `## 🥙 ${this.name} \n`;
     commentBody += `${this.description}\n`;
     this.stepResult.results.forEach((actionResult) => {
-      commentBody += `- [ ] Rename **${actionResult.file}** to **${actionResult.file}**\n`;
+      commentBody += `- [ ] Rename **${actionResult.file}** to **${actionResult.details}**\n`;
     });
-
-    commentBody += `\n \n Additionally, don't forget to add the \`:page-aliases:\` attribute after renaming the files to avoid broken links or references.`;
+    commentBody += `
+> [!warning]
+> Additionally, don't forget to add the \`:page-aliases:\` attribute after renaming the **existing files** to avoid broken links or references. `;
 
     return commentBody;
   }