Skip to content

Commit 50c6599

Browse files
author
Joan Edwards
committed
Contribution guide
1 parent e724c17 commit 50c6599

File tree

6 files changed

+288
-0
lines changed

6 files changed

+288
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve documentation
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the Bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Steps to Reproduce**
14+
1.
15+
2.
16+
3.
17+
18+
**Expected Behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
22+
23+
**Additional context**
24+
Add any other context about the problem here. If applicable, add screenshots to help explain your problem.

‎.github/ISSUE_TEMPLATE/feature-request.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this documentation repository
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is.
12+
13+
**Describe the solution you would like to see**
14+
A clear and concise description of what you want to happen.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE/pull-request-template.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- General PR guidelines:
2+
3+
Most PRs should be opened against the master branch.
4+
5+
-->
6+
7+
## Proposed Changes
8+
9+
-
10+
-
11+
-
12+
13+
## Description
14+
- Fixes Issue #
15+
- Version:

‎contributing/con_contributing-documentation.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing to Knative on OpenShift Documentation
2+
3+
* [Before You Begin](#Before-You-Begin)
4+
* [General Information](#General-Information)
5+
* [Raising an Issue](#Raising-an-Issue)
6+
* [Put in a Pull Request](#Put-in-a-Pull-Request)
7+
* [Code of Conduct](#Code-of-Conduct)
8+
9+
-----------------------------
10+
11+
**You can contribute by:**
12+
- Raising an issue you find in the documentation
13+
- Fixing issues by opening a pull request
14+
- Improving documentation or code samples
15+
16+
All bugs, tasks or enhancements are tracked as [GitHub issues](https://github.com/openshift-knative/docs/issues). Use labels to indicate requirements and information related to the reported issue.
17+
18+
## Before You Begin
19+
20+
* [Get started](/contributing/proc_git-set-up.md) by installing and getting familiar with [Git](https://git-scm.com/doc).
21+
* Use [markdown](https://www.markdownguide.org/) to contribute documentation to the repository and add a link to the README.md, if applicable.
22+
* Refer to our [style guide](/contributing/ref_documentation-styling.md) for guidance on formatting your documentation contributions.
23+
24+
## General Information
25+
26+
Thank you for your contributions! Please follow this process to submit a patch:
27+
28+
1. Create an issue describing your proposed change to the repository.
29+
30+
1. The repository owners will triage and respond to your issue promptly.
31+
32+
1. Fork the repository and create a topic branch.
33+
34+
1. Submit a pull request with the proposed changes.
35+
- The required format for the Git commit message is "Issue #<issue_no -- message>".
36+
37+
38+
## Raising an Issue
39+
40+
GitHub issues can be used to report bugs or submit feature requests.
41+
42+
When reporting an issue, you can use the [applicable issue reporting template](https://github.com/openshift-knative/docs/issues/new/choose). Please include the following information:
43+
44+
* The version of the project you are using (version number, git commit, etc.)
45+
* Operating system you are using
46+
* The exact, minimal, steps needed to reproduce the issue.
47+
48+
49+
## Put in a Pull Request
50+
51+
Make a pull request (PR) to add content to the repository. When making a PR, ensure you include:
52+
53+
* A description of what the PR fixes
54+
* Associated issue# and issue title (if applicable)
55+
* The version of the project you are using (version number, git commit, etc.)
56+
* Operating system you are using
57+
58+
See [here](/contributing/proc_git-set-up.md) for more information on using Git and making pull requests.
59+
60+
61+
## Code of Conduct
62+
63+
Examples of behavior that contributes to creating a positive environmentinclude:
64+
65+
* Using welcoming and inclusive language
66+
* Focusing on what is best for the community
67+
* Being respectful of differing viewpoints and experiences
68+
* Gracefully accepting constructive criticism
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/version/1/4).

‎contributing/proc_git-setup.md

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# Using Git
2+
3+
Knative on OpenShift uses Git to manage repositories. This guide explains how to set up your system to connect to the proper git repositories.
4+
5+
`openshift-knative/docs`is a public GitHub repository that hosts the Knative on OpenShift documentation.
6+
7+
* [Installing Git](#Installing-Git)
8+
* [Configuring Git](#Configuring-Git)
9+
* [Fork the upstream repository](#Fork-the-upstream-(GitHub)-repository)
10+
* [Add your SSH keys](#Add-your-SSH-keys-to-GitHub)
11+
* [Updating repository URLs](#Updating-repository-URLs)
12+
* [Accessing unmerged commits](#Accessing-another-writer’s-unmerged-commits)
13+
* [Additional resources](#Additional-resources)
14+
15+
----------------------------
16+
### Installing Git
17+
18+
If using Fedora, open your terminal and enter the proper installation command.
19+
20+
#### Fedora
21+
For installation use:
22+
23+
Up to Fedora 21
24+
```
25+
$ yum install git
26+
```
27+
Fedora 22 and later
28+
```
29+
$ dnf install git
30+
```
31+
32+
#### Other operating systems
33+
34+
* [Download Git](https://git-scm.com/downloads)
35+
36+
37+
-----------------------------------------
38+
### Configuring Git
39+
40+
Once you have Git installed, set up your Git account.
41+
42+
#### Procedure
43+
1. Open **Terminal**
44+
2. Set your name and email
45+
46+
```
47+
$ git config --global user.name "<your-name>"
48+
$ git config --global user.email "<your-email>"
49+
```
50+
51+
> **TIP:** The email you specify should be the same one found in your [email settings](https://help.github.com/articles/adding-an-email-address-to-your-github-account/). To keep your email address hidden, see [Keeping your email address private](https://help.github.com/articles/keeping-your-email-address-private).
52+
53+
3. Set your Git defaults
54+
55+
```
56+
$ git config --global pull.rebase true
57+
$ git config --global push.default simple
58+
```
59+
60+
-----------------------------------------
61+
### Fork the upstream (GitHub) repository
62+
63+
Fork the `openshift-knative/docs` upstream repository to create a copy under your own GitHub ID. Clone your forked repository to bring your GitHub repository files to your local machine. Your forked repository is now the `origin` repository for your local files.
64+
65+
#### Procedure
66+
1. Open a browser and navigate to the upstream repository located at https://github.com/openshift-knative/docs.git
67+
2. Click **Fork** located in the upper right under your profile icon.
68+
3. Select your user account for the location of the forked repository. This creates your own copy of the repository under your own GitHub ID.
69+
70+
> **NOTE:** For more information on [forking](https://help.github.com/articles/fork-a-repo/) and [cloning](https://help.github.com/articles/cloning-a-repository/), consult the official [documentation](https://help.github.com/).
71+
72+
73+
-----------------------------------------
74+
### Add your SSH keys to GitHub
75+
If you choose to use the SSH address for your clones, you will need to add an SSH Key to GitHub first.
76+
77+
#### Procedure
78+
1. Open *Terminal*.
79+
2. Check to see if you have a public SSH key:
80+
81+
````
82+
$ ls ~/.ssh/
83+
````
84+
3. If you do not have a key, generate one:
85+
86+
```
87+
$ ssh-keygen -t rsa -C "<your-email>"
88+
```
89+
4. Open your key in an editor:
90+
91+
```
92+
$ cd ~/.ssh/
93+
$ vi id_rsa.pub
94+
```
95+
5. Copy the contents of the file to your clipboard.
96+
6. Visit [https://github.com/settings/keys](https://github.com/settings/keys)
97+
7. Click **New SSH Key**.
98+
8. Name your key and paste the contents of your key file.
99+
9. Click **Add SSH Key**.
100+
101+
102+
-----------------------------------------
103+
### Updating repository URLs
104+
105+
If the upstream repository is moved, you can change the downstream URL by using the following command:
106+
107+
```
108+
$ git remote set-url upstream https://github.com/<new upstream>
109+
```
110+
111+
Use the following command any time you need to fetch the latest source code locally:
112+
113+
```
114+
$ git fetch upstream
115+
```
116+
117+
118+
------------------------------------------
119+
### Accessing another writer’s unmerged commits
120+
121+
This is the process you can use if you need commits another writer has submitted that is not yet merged.
122+
123+
1. Check out a new topic branch from upstream/master as you normally do.
124+
125+
```
126+
$ git fetch upstream
127+
$ git checkout -b <new-topic-branch> upstream/master
128+
```
129+
130+
2. If you have not yet added that writer’s remote repository, add it now.
131+
132+
```
133+
$ git remote add -f <user> [email protected]:<user>/strimzi-kafka-operator.git
134+
```
135+
136+
3. Rebase to bring in the changes that are in that user’s outstanding
137+
`origin/<merge-request-branch>` branch.
138+
139+
```
140+
$ git rebase <user>/<merge-request-branch>
141+
```
142+
143+
---------------------------------------
144+
### Additional resources
145+
146+
* [Official Git Site](https://git-scm.com)
147+
* [GitHub Help](http://help.github.com)

‎contributing/ref_documentation-styling.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Style Guidelines
2+
3+
## General Quick Reference
4+
5+
|Item |Use |Not
6+
--- |--- |--- |
7+
|Filesystem names and paths, symbols, and literals. |`filename` |
8+
|GUI items (_Match the capitalization of the button_) |**bold** |
9+
|Navigation link text |**bold** |
10+
|Superuser console commands | $ sudo |#
11+
|Emphasis |_yay_ |*yay*
12+
|Decimal integers < 10 |five |5
13+
|Decimal integers >= 10 |15 |fifteen
14+
|Number ranges (_always use numerals_) |1-20 |1-twenty
15+
|Do not use Latin abbreviations |that is |i.e.

0 commit comments

Comments
 (0)