This contributing doc is for EXTERNAL USERS only. See the following information to contribute to the docs.
Because most changes need to be reviewed by development, doc, and QE, open an issue with the suggestion and let the team make the changes after discussion.
You can create a PR if your change is small and requires no debate, but we still need a GitHub issue opened for tracking purposes. You must fork the project and create your own branch to create a pull request.
The documentation source is in ASCIIDoc format, and the content that is provided in PRs must conform to the ASCIIDoc requirements. You can find some guidance for authoring in ASCIIDoc in the AsciiDoc Syntax quick reference.
Note: All PRs outside of a typo fix require an issue.
Open an issue here: https://github.com/open-cluster-management/rhacm-docs/issues/new. Complete the template with the information that is required for your requested change.
Your new issue goes into the new issues column on our ZenHub board, where it will be assigned to the correct writer. This is our open, doc-only board. Internal issues between development and doc are in the team’s backlog and treated the same.
Once the change from your issue is accepted, reviewed, and merged into the staging docs for that release, we will let you know in the issue comments and you can close the issue.
You are currently viewing the a staged default branch, which is the in-progress branch. WARNING: The default branch is in progress and used for internal development only. You need to checkout a supported branch before you create a PR.
We support documentation for the current release, and the previous 2 releases (n-2). We refresh these releases weekly. If you need an update that is exclusive to a previous release, open an issue and propose that change.
Currently supported versions and branches:
| Release | Branch | Release status |
|---|---|---|
2.1 |
Live: Red Hat Advanced Cluster Management for Kubernetes version 2.1 |
|
2.0 |
Live: Red Hat Advanced Cluster Management for Kubernetes version 2.0 |