This is a repository for Red Hat Developer (RHDH) documentation.

Contribute to this repository to add new and edit existing RHDH documentation published on theRed Hat Documentation page.

Before submitting a pull request (PR), create a Jira issue associated with your contribution to this repository.

There are currently three Jira projects related to RHDH:

• RHDHBUGS - For issues related to existing content.

• RHIDP - For new features related to the core platform, including security mechanisms.

• RHDHPAI - For new features related to plugins and AI.

Choose a Jira project that matches your contribution and create a new issue:

1. In the Jira project, clickCreate.

2. In theDescription field, describe your contribution.

3. In theComponent/s field, selectDocumentation from the drop-down list.

4. Save the created Jira issue.

All contributions are in AsciiDoc.

Make sure your writing follows the ruleslisted inIBM Style andRed Hat supplementary style guide.

Follow theModular documentation reference guideto modularize your content.

1. Installasciidoctor - seehttps://docs.asciidoctor.org/asciidoctor/latest/install/linux-packaging/

2. Install Podman - seehttps://podman.io.

3. Run the following command to generate html with images in titles-generated/ folders by usingccutil in a container.Theccutil CLI tool reproduces the behavior of the production publication chain (Pantheon), including its limitations, and is therefore preferred over using a more recentasciidoctor CLI version.

   $  build/scripts/build-ccutil.sh

You can runhtmltest locally to check for broken links in your PR.

1. Installhtmltest fromhttps://github.com/wjdp/htmltest

2. Run the following command:

   $ htmltest

You can runlinkchecker to check for broken links in the published RHDH docs.

1. Installlinkchecker fromhttps://github.com/linkchecker/linkchecker.

2. Run the following command to create a .txt file with a list of detected broken links:

   $ linkchecker --check-extern --output failures --file-output failures/broken-links.txt https://docs.redhat.com/en/documentation/red_hat_developer_hub/<version>

You can view commits to this repo as GitHub Page content here:

https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/

PRs have a link to the generated HTML attached as a comment.

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

When possible, request a tech review first and implement suggestions from the SME.After your PR is approved by the tech reviewer, follow it up with a request a peer review.

Checkthis doc for the current peer review roster.

After the peer and tech reviewer approve your PR, the PR is ready for merging and cherry-picking by a gatekeeper.

Checkthis doc for the current gatekeeper roster.

As you work on your contribution to this repo,use labels to show the status of your PR and to request reviews:

• draft:do-not-merge/work-in-progress

• ready for peer and technical reviews:do-not-merge/review-in-progress

• request for a tech review:technical-review-needed

• completed tech review:technical-review-done

• request for a peer review:peer-review-needed

• completed peer review:peer-review-done

• ready for merging:ready-to-merge

This repo is the upstream mirror of the GitLab RHDH repohttps://gitlab.cee.redhat.com/red-hat-developers-documentation/rhdh

Merged PRs are synced to GitLab for build with Pantheon.

For Plugin configuration guide, see upstream content inhttps://github.com/janus-idp/backstage-plugins/tree/main/plugins

• RHDH documentation contributor guide

• link:https://spaces.redhat.com/spaces/RHDEVDOCS/pages/494635174/Content+creation+guidelines [RHDH content creation guidelines]

• RHDH GitHub labels