openshift/openshift-docs

= OpenShift documentation

• https://www.okd.io/[OKD]
• https://www.openshift.com/products/online/[OpenShift Online]
• https://www.openshift.com/products/container-platform/[OpenShift Container Platform]
• https://www.openshift.com/products/dedicated/[OpenShift Dedicated]

All OpenShift documentation is sourced in https://asciidoc.org/[AsciiDoc] and transformed into HTML/CSS and other formats through automation that is based on https://asciidoctor.org/[AsciiDoctor].

The documentation published from these source files can be viewed at https://docs.openshift.com.

== Contributing to OpenShift documentation // NOTE: This text is mirrored in ./CONTRIBUTING.adoc // If you update one, update both.

If you are interested in contributing to OpenShift technical documentation, you can view all our link:./contributing_to_docs[resources] that will help you get set up and provide more information.

The following table provides quick links to help you get started.

[options="header"] |===

|Question |Link

|I'm interested, how do I contribute? |See the link:/contributing_to_docs/contributing.adoc[contributing] topic to learn more about this repository and how you can contribute.

|Are there any basic guidelines to help me? |The link:/contributing_to_docs/doc_guidelines.adoc[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 link:/contributing_to_docs/tools_and_setup.adoc[tools and setup] topic to set up your workstation.

|How do I edit an existing topic, or create new content? |See the link:/contributing_to_docs/create_or_edit_content.adoc[create or edit content] topic to get started.

|===

== Contacts

For questions or comments about OpenShift documentation:

• Send an email to the OpenShift documentation team at [email protected].