You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Choose a Jira project that matches your contribution and create a new issue:
18
18
@@ -23,9 +23,8 @@ Choose a Jira project that matches your contribution and create a new issue:
23
23
24
24
[IMPORTANT]
25
25
====
26
-
RHDH release notes are single-sourced from the *Release Notes Text* field in the Jira Epic.
27
-
If you want to make changes to release notes, you must make them in Jira.
28
-
Check the link:https://docs.google.com/document/d/1X2CrrU9K3ZqbxN7DXmU6P1mY7inLD32qs3rpOUHz6Vw/edit?tab=t.0#heading=h.yqxd252ryhua[RHDH Release Notes process document] for more information.
26
+
RHDH release notes are single-sourced from Jira.
27
+
See the link:https://docs.google.com/document/d/1X2CrrU9K3ZqbxN7DXmU6P1mY7inLD32qs3rpOUHz6Vw/edit?tab=t.0#heading=h.yqxd252ryhua[RHDH Release Notes process document] and the link:https://gitlab.cee.redhat.com/red-hat-developers-documentation/red-hat-developer-hub-release-notes[release notes repository] (VPN required) for details.
29
28
====
30
29
31
30
## Style and formatting
@@ -46,36 +45,64 @@ to modularize your content.
46
45
47
46
## Building locally
48
47
49
-
. Install `asciidoctor` - see https://docs.asciidoctor.org/asciidoctor/latest/install/linux-packaging/
50
-
. Install Podman - see https://podman.io.
51
-
. Run the following command to generate html with images in titles-generated/ folders by using `ccutil` in a container.
52
-
The `ccutil` CLI tool reproduces the behavior of the production publication chain (Pantheon), including its limitations, and is therefore preferred over using a more recent `asciidoctor` CLI version.
48
+
.Prerequisites
49
+
50
+
* link:https://nodejs.org[Node.js]
51
+
* link:https://podman.io[Podman]
52
+
* link:https://github.com/errata-ai/vale[Vale]
53
+
* link:https://github.com/lycheeverse/lychee[Lychee] (downloaded automatically by the build script if not installed)
54
+
* Optional: A `GITHUB_TOKEN` environment variable to avoid GitHub API rate limiting during lychee link validation. Use link:https://cli.github.com[GitHub CLI] (`gh`) to get and refresh the token: `export GITHUB_TOKEN=$(gh auth token)`
55
+
56
+
.Procedure
57
+
58
+
. Sync the Vale style rules:
59
+
+
60
+
[source,terminal]
61
+
----
62
+
$ vale sync
63
+
----
64
+
65
+
. Build HTML with images in `titles-generated/` using `ccutil` in a container, then run lychee link validation and CQA content quality checks:
53
66
+
54
67
[source,terminal]
55
68
----
56
-
$ build/scripts/build-ccutil.sh
69
+
$ ./build/scripts/build-ccutil.sh
57
70
----
71
+
+
72
+
The `ccutil` CLI tool reproduces the behavior of the production publication chain (Pantheon), including its limitations, and is therefore preferred over `asciidoctor`.
73
+
74
+
Results are written to `build-report.json`.
58
75
59
76
## Checking for broken links
60
77
61
-
You can run `lychee` locally to check for broken links in your PR.
78
+
The build command above includes lychee link validation automatically.
* Optional: A `GITHUB_TOKEN` environment variable to avoid GitHub API rate limiting. Use link:https://cli.github.com[GitHub CLI] (`gh`) to get and refresh the token: `export GITHUB_TOKEN=$(gh auth token)`
@@ -93,6 +120,8 @@ The publication workflow has two stages:
93
120
. The link:.github/workflows/pr.yml[PR workflow] and link:.github/workflows/build-asciidoc.yml[GitHub Pages workflow] build HTML from AsciiDoc sources and push the output to the `gh-pages` branch using `build/scripts/deploy-gh-pages.js`, which handles concurrent pushes with automatic retry, cleanup of stale PR/branch directories, and index regeneration.
94
121
. The link:https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/actions/workflows/pages/pages-build-deployment[GitHub Pages build and deployment] workflow, managed by GitHub, detects pushes to the `gh-pages` branch and publishes the content to GitHub Pages.
95
122
123
+
See link:docs/github-publication-workflow.md[GitHub Publication Workflow Architecture] for the full technical reference.
124
+
96
125
## Reviews
97
126
98
127
All PRs are reviewed for technical accuracy by an SME and writing quality by another tech writer.
0 commit comments