Skip to content

Commit a651196

Browse files
committed
copies 'Contributing' intro from README to CONTRIBUTING
1 parent aa1f12f commit a651196

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CONTRIBUTING.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
= Contributing to OpenShift documentation
2+
// NOTE: This text mirrors the "Contributing to OpenShift documentation" section in ./README.adoc
3+
// If you update one, update both.
4+
5+
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.
6+
7+
8+
The following table provides quick links to help you get started.
9+
10+
[options="header"]
11+
|===
12+
13+
|Question |Link
14+
15+
|I'm interested, how do I contribute?
16+
|See the link:/contributing_to_docs/contributing.adoc[contributing] topic to learn more about this repository and how you can contribute.
17+
18+
|Are there any basic guidelines to help me?
19+
|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.
20+
21+
|How do I set up my workstation?
22+
|See the link:/contributing_to_docs/tools_and_setup.adoc[tools and setup] topic to set up your workstation.
23+
24+
|How do I edit an existing topic, or create new content?
25+
|See the link:/contributing_to_docs/create_or_edit_content.adoc[create or edit content] topic to get started.
26+
27+
|===

README.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ All OpenShift documentation is sourced in https://asciidoc.org/[AsciiDoc] and tr
1010
The documentation published from these source files can be viewed at https://docs.openshift.com.
1111

1212
== Contributing to OpenShift documentation
13+
// NOTE: This text is mirrored in ./CONTRIBUTING.adoc
14+
// If you update one, update both.
15+
1316
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.
1417

1518

0 commit comments

Comments
 (0)