Skip to content

Commit 3c39bf4

Browse files
authored
add documentation on how to write documentation (#952)
* add documentation on how to write documentation * updates based on review feedback * typo
1 parent 3fada0c commit 3c39bf4

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,4 @@ release.properties
4343
dependency-reduced-pom.xml
4444
*.ipr
4545
*.iws
46+
docs-source/docs
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "Documentation"
3+
date: 2019-03-19T07:13:22-04:00
4+
draft: false
5+
weight: 9
6+
---
7+
8+
This documentation is produced using [Hugo](http://gohugo.io). To make an
9+
update to the documentation, follow this process:
10+
11+
1. Clone the repository if you have not already
12+
13+
```
14+
git clone https://github.com/oracle/weblogic-kubernetes-operator
15+
```
16+
17+
2. Create a new branch from master
18+
19+
```
20+
git checkout master
21+
git pull origin master
22+
git checkout -b your-branch
23+
```
24+
25+
3. Make your documentation updates by editing the source files in
26+
`docs-source/content`.
27+
28+
4. If you wish to view your changes you can run the site locally using
29+
these commands; the site will be available on the URL shown here:
30+
31+
```
32+
cd docs-source
33+
hugo server -b http://localhost:1313/weblogic-kubernetes-operator
34+
```
35+
36+
5. When you are ready to submit your changes, push your branch to `origin`
37+
and submit a pull request. Remember to follow the guidelines in the
38+
[CONTRIBUTING](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/CONTRIBUTING.md)
39+
document.
40+
41+
{{% notice note %}}
42+
Make sure you only check in your source code changes in `docs-source`; do
43+
not build the site and check in the static files.
44+
{{% /notice %}}

0 commit comments

Comments
 (0)