OpenShift Documentation Issues

Solution Verified - Updated -

Environment

  • Red Hat OpenShift Container Platform (RHOCP) 4

Issue

  • There is a problem with the OpenShift Documentation
  • Some section of the OpenShift Documentation is not clear enough
  • There are undocumented features in some functionalities of OpenShift
  • What to do if something in the OpenShift Documentation is wrong?
  • Some organizations are not going to adopt OpenShift functionalities until they are officially documented

Resolution

Disclaimer: Links contained herein to external website(s) are provided for convenience only. Red Hat has not reviewed the links and is not responsible for the content or its availability. The inclusion of any link to an external website does not imply endorsement by Red Hat of the website or their entities, products or services. You agree that Red Hat is not responsible or liable for any loss or expenses that may result due to your use of (or reliance on) the external site or content.

To contribute at improving the OpenShift documentation there are several options:

  • Navigate to the relevant sub page on https://docs.openshift.com/ and click on the "bug" icon on the top right corner of the screen. When hovering on the icon the text "Open an issue" appears. Clicking on the icon will open a page on the Jira portal https://issues.redhat.com/ From there, it is possible to suggest exactly the improvements that should be added to the documentation.
  • Open an issue on the OpenShift documentation project on GitHub
  • Open a support ticket with the Red Hat OpenShift Support Team and report the issue .
  • As a last resort it is possible to email the OpenShift Documentation Team directly at: openshift-docs@redhat.com

Note: It is possible to use a Red Hat Customer Portal account to login in Jira. It will use SSO for authentication.

Note: About RHOCP 3 documentation issues - Since RHOCP 3 is currently in the Extended Life Phase (there are no bug fixes, security fixes, new certifications, hardware enablement, feature enhancements, or root cause analysis available) any request for improvement of the documentation either via Jira or via GitHub issues might not be accepted.

Root Cause

All OpenShift documentation is licensed under the Apache License 2.0, therefore everyone can contribute by suggesting content or correcting typos/errors.

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.

Comments