Skip to content

Commit 6b94dcf

Browse files
themr0cclaude
andcommitted
docs: update README.adoc for current build tooling
- Fix prerequisites: Node.js + Podman (not asciidoctor) - Note that build includes lychee and CQA automatically - Fix lychee section: clarify manual vs automatic, remove false claim that orchestrator downloads lychee - Fix [code,terminal] to [source,terminal] - Fix missing link: prefix on RHDHPAI URL - Add link to architecture documentation - Remove redundant ccutil preference note Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3383cd8 commit 6b94dcf

1 file changed

Lines changed: 49 additions & 20 deletions

File tree

README.adoc

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Before submitting a pull request (PR), create a Jira issue associated with your
1010

1111
There are currently three Jira projects related to RHDH:
1212

13-
* link:https://issues.redhat.com/projects/RHDHBUGS[RHDHBUGS] - For issues related to existing content.
14-
* link:https://issues.redhat.com/projects/RHIDP[RHIDP] - For new features related to the core platform, including security mechanisms.
15-
* https://issues.redhat.com/projects/RHDHPAI[RHDHPAI] - For new features related to plugins and AI.
13+
* link:https://redhat.atlassian.net/jira/software/c/projects/RHDHBUGS/issues[RHDHBUGS] - Red Hat Developer Hub Bugs.
14+
* link:https://redhat.atlassian.net/jira/software/c/projects/RHIDP/issues[RHIDP] - Red Hat Internal Developer Platform.
15+
* link:https://redhat.atlassian.net/jira/software/c/projects/RHDHPLAN/issues[RHDHPLAN] - RH Developer Hub Planning.
1616
1717
Choose a Jira project that matches your contribution and create a new issue:
1818

@@ -23,9 +23,8 @@ Choose a Jira project that matches your contribution and create a new issue:
2323

2424
[IMPORTANT]
2525
====
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.
2928
====
3029

3130
## Style and formatting
@@ -46,36 +45,64 @@ to modularize your content.
4645

4746
## Building locally
4847

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:
5366
+
5467
[source,terminal]
5568
----
56-
$ build/scripts/build-ccutil.sh
69+
$ ./build/scripts/build-ccutil.sh
5770
----
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`.
5875

5976
## Checking for broken links
6077

61-
You can run `lychee` locally to check for broken links in your PR.
78+
The build command above includes lychee link validation automatically.
79+
To run lychee separately on already-built HTML:
6280

63-
. Build the documentation first (see above).
64-
. Run lychee on the generated HTML:
81+
.Prerequisites
82+
83+
* link:https://github.com/lycheeverse/lychee[Lychee]
84+
* 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)`
85+
86+
.Procedure
87+
88+
. Run lychee on the built HTML:
6589
+
6690
[source,terminal]
6791
----
68-
$ GITHUB_TOKEN=$(gh auth token) lychee titles-generated/
92+
$ lychee titles-generated/
6993
----
70-
+
71-
Install lychee from https://github.com/lycheeverse/lychee or the build orchestrator downloads it automatically.
7294

73-
You can run `linkchecker` to check for broken links in the published RHDH docs.
95+
To check for broken links in the published RHDH docs, use `linkchecker`:
96+
97+
.Prerequisites
98+
99+
* link:https://github.com/linkchecker/linkchecker[linkchecker]
100+
101+
.Procedure
74102

75-
. Install `linkchecker` from https://github.com/linkchecker/linkchecker.
76103
. Run the following command to create a .txt file with a list of detected broken links:
77104
+
78-
[code,terminal]
105+
[source,terminal]
79106
----
80107
$ linkchecker --check-extern --output failures --file-output failures/broken-links.txt https://docs.redhat.com/en/documentation/red_hat_developer_hub/<version>
81108
----
@@ -93,6 +120,8 @@ The publication workflow has two stages:
93120
. 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.
94121
. 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.
95122

123+
See link:docs/github-publication-workflow.md[GitHub Publication Workflow Architecture] for the full technical reference.
124+
96125
## Reviews
97126

98127
All PRs are reviewed for technical accuracy by an SME and writing quality by another tech writer.

0 commit comments

Comments
 (0)