update action text

elastic · Dec 13, 2023 · bff88a3 · bff88a3
1 parent 237f6a4
commit bff88a3
Showing 1 changed file with 20 additions and 22 deletions.
diff --git a/.github/actions/docs-preview/action.yml b/.github/actions/docs-preview/action.yml
@@ -27,29 +27,27 @@ runs:
         script: |
           const { REPO, PR, PREVIEW_PATH } = process.env
 
-          const comment = `A documentation preview will be available soon.
-          Help us out by validating the Buildkite preview and reporting issues [here](https://github.com/elastic/docs/issues/new?labels=buildkite-migration,bug). Please also be sure to **double check all images to ensure they are correct** in the preview.
-
-            - 🔨 Buildkite [builds](https://buildkite.com/elastic/docs-build-pr/builds?meta_data[repo_pr]=${REPO}_${PR})
-            - 📚 HTML diff: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/diff)  - [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/diff)
-            - 📙 Preview: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH})  -  [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH})
-            - 🧪 [Buildkite vs Jenkins diff](https://github.com/elastic/built-docs/compare/${REPO}_bk_${PR}..${REPO}_${PR})
-
-           <details>
-            <summary>Requesting new docs builds via comments</summary>
-
-          \`\`\`
-              run docs-build
-              run docs-build rebuild
-              run docs-build warnlinkcheck
-              run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)
-              buildkite test this
-              buildkite test this rebuild
-              buildkite test this warnlinkcheck
-              buildkite test this skiplinkcheck 
-          \`\`\`
+          const comment = `A documentation preview will be available soon.<br>
+          Help us out by validating the Buildkite preview and reporting issues [here](https://github.com/elastic/docs/issues/new?labels=buildkite-migration,bug).
+          Please also be sure to **double check all images to ensure they are correct** in the preview.
+
+          - 🔨 Buildkite [builds](https://buildkite.com/elastic/docs-build-pr/builds?meta_data[repo_pr]=${REPO}_${PR})
+          - 📚 HTML diff: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/diff)  - [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/diff)
+          - 📙 Preview: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH})  -  [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH})
+          - 🧪 [Buildkite vs Jenkins diff](https://github.com/elastic/built-docs/compare/${REPO}_bk_${PR}..${REPO}_${PR})
+
+
+          <details>
+          <summary>Request a new doc build by commenting</summary>
+
+          * Rebuild this PR: \`run docs-build\`
+          * Rebuild this PR and all Elastic docs: \`run docs-build rebuild\`
+
+          <sub>`run docs-build` is much faster than `run docs-build rebuild`. A `rebuild` should only be needed in rare situations. </sub>
+
+          <sub>If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status [here](https://buildkite.com/elastic/docs-build).</sub>
           </details>
-            `;
+          `;
 
           github.rest.issues.createComment({
             issue_number: PR,