Skip to content

Commit 71372f7

Browse files
authored
Merge pull request #959 from oracle/docs-source-readme
Add README file for new documentation sources
2 parents fba5359 + bf4390a commit 71372f7

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

docs-source/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Oracle WebLogic Server Kubernetes Operator Documentation
2+
3+
***
4+
For information on updating and contributing to the operator
5+
documentation, see the _Documentation_ section of the
6+
[Developer Guide](https://oracle.github.io/weblogic-kubernetes-operator/developerguide/documentation)
7+
***

docs-source/content/developerguide/documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ update to the documentation, follow this process:
2424
2525
3. Make your documentation updates by editing the source files in
2626
`docs-source/content`.
27+
{{% notice note %}}
28+
Make sure you only check in the changes from the `docs-source/content` area;
29+
do not build the site and check in the static files.
30+
{{% /notice %}}
2731
2832
4. If you wish to view your changes you can run the site locally using
2933
these commands; the site will be available on the URL shown here:
@@ -38,7 +42,3 @@ and submit a pull request. Remember to follow the guidelines in the
3842
[CONTRIBUTING](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/CONTRIBUTING.md)
3943
document.
4044
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)