|
Important
|
This repository is in maintenance mode and is not accepting contributions from outside the OpenShift documentation team, including AI-generated pull requests. We are migrating the documentation to a new platform, with completion planned by the end of calendar year 2026. The migration requires extensive restructuring and coordination across the documentation set. To keep this work consistent, contributions are limited to the documentation team during the transition. Customers and stakeholders, including engineering and support teams, should open a documentation bug in Jira instead of submitting a pull request. Include the affected documentation URL, a description of the issue, and any suggested corrections. |
All OpenShift documentation is sourced in AsciiDoc and transformed into HTML/CSS and other formats through automation that is based on AsciiDoctor.
The documentation published from these source files can be viewed at https://docs.openshift.com.
Documentation team members can use the contribution resources and the links below to follow the existing workflow.
The following table provides quick links to help you get started.
| Question | Link |
|---|---|
How do documentation team members contribute? |
See the contributing topic to learn more about this repository and how you can contribute. |
Are there any basic guidelines to help me? |
The documentation guidelines topic provides some basic guidelines to help us keep our content consistent, and includes other style information. |
How do I set up my workstation? |
See the tools and setup topic to set up your workstation. |
How do I edit an existing topic, or create new content? |
See the create or edit content topic to get started. |
For questions or comments about OpenShift documentation:
-
Send an email to the OpenShift documentation team at openshift-docs@redhat.com.