|
1 | 1 | = OpenShift Documentation
|
2 |
| -Welcome to the OpenShift documentation GitHub repository that contains the source files for the technical documentation for the following products: |
3 | 2 |
|
4 |
| -* https://www.okd.io/[OKD] |
5 |
| -* https://www.openshift.com/products/online/[OpenShift Online] |
6 |
| -* https://www.openshift.com/products/container-platform/[OpenShift Container Platform] |
7 |
| -* https://www.openshift.com/products/dedicated/[OpenShift Dedicated] |
8 |
| -
|
9 |
| -All OpenShift documentation is sourced in http://www.methods.co.nz/asciidoc/[AsciiDoc] and transformed into HTML/CSS and other formats through automation that is based on http://asciidoctor.org/[AsciiDoctor]. |
10 |
| - |
11 |
| -The documentation published from these source files can be viewed at http://docs.openshift.com. |
12 |
| - |
13 |
| -== Contributing to OpenShift documentation |
14 |
| -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. |
15 |
| - |
16 |
| - |
17 |
| -The following table provides quick links to help you get started. |
18 |
| - |
19 |
| -[options="header"] |
20 |
| -|=== |
21 |
| - |
22 |
| -|Question |Link |
23 |
| - |
24 |
| -|I'm interested, how do I contribute? |
25 |
| -|See the link:/contributing_to_docs/contributing.adoc[contributing] topic to learn more about this repository and how you can contribute. |
26 |
| - |
27 |
| -|Are there any basic guidelines to help me? |
28 |
| -|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. |
29 |
| - |
30 |
| -|How do I set up my workstation? |
31 |
| -|See the link:/contributing_to_docs/tools_and_setup.adoc[tools and setup] topic to set up your workstation. |
32 |
| - |
33 |
| -|How do I edit an existing topic, or create new content? |
34 |
| -|See the link:/contributing_to_docs/create_or_edit_content.adoc[create or edit content] topic to get started. |
35 |
| -|=== |
36 |
| - |
37 |
| -== Contacts |
38 |
| - |
39 |
| -For questions or comments about OpenShift documentation: |
40 |
| - |
41 |
| -* OpenShift team members can be found on the http://webchat.freenode.net/?randomnick=1&channels=openshift&uio=d4[#openshift] and http://webchat.freenode.net/?randomnick=1&channels=openshift-dev&uio=d4[#openshift-dev] channels on http://www.freenode.net/[FreeNode]. |
42 |
| -* You can also join the http://lists.openshift.redhat.com/openshiftmm/listinfo/users[Users] or http://lists.openshift.redhat.com/openshiftmm/listinfo/dev[Developers] mailing list. |
43 |
| -* Send an email to the OpenShift documentation team at openshift-docs@redhat.com. |
| 3 | +Welcome to the OpenShift documentation GitHub repository. To contribute to OpenShift docs, see https://github.com/openshift/openshift-docs/blob/master/README.adoc |
0 commit comments