Skip to content

Commit fd4f541

Browse files
authored
Place documentation contributors guide in more discoverable location (#1268)
1 parent 9cf0365 commit fd4f541

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed
Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1-
## Compiled Docs
1+
# Contributing
2+
3+
## Documentation
24

35
There are several pieces that go into the docs.
46

57
Note: Paths are all relative to the root of the project.
68

7-
1) Content files (markdown) files in `docs-src/main/`. These contain the content and links to code snippets defined in
8-
java src files.
9+
1) Content files (markdown) files in `docs-src/main/`. These contain the content and links to code snippets defined in java src files.
910

1011
2) src files (java) that hold the compiled code (can be anywhere in the project, but are generally in `docs-src/src/`)
1112

1213
3) the output of running snippets in the src files. E.G. the output of running `table.first(10)`
1314

1415
4) The built docs that have not necessarily released are in `docs-src/dist/`
1516

16-
5) The released/deployed docs are in `docs/` at the root of the project. (Github automatically serves whatever is
17-
in the `docs/` directory in the master branch)
18-
17+
5) The released/deployed docs are in `docs/` at the root of the project. (Github automatically serves whatever is in the `docs/` directory in the master branch)
1918

20-
### To update the Docs
19+
### Rebuilding and deploying the docs
2120

2221
1) Navigate to the `./docs-src` sub directory (Where POM is located).
2322

@@ -32,10 +31,8 @@ This will inject snippets into content files and copy everything the content to
3231
4) To deploy the docs run the shell script `./deploy_docs.sh`.
3332

3433
* This will copy the `docs-src/dist/` directory to `docs/`
35-
* Having a staging location for the built docs allows us to choose when to release them.
36-
We can now work on the docs for a new feature and then release them at the same time the
37-
feature is released.
34+
* Having a staging location for the built docs allows us to choose when to release them. We can now work on the docs for a new feature and then release them at the same time the feature is released.
3835

39-
### Notes
40-
For more background on injecting snippets see:
41-
https://github.com/ryancerf/choss-maven-plugin
36+
### Notes
37+
38+
For more background on injecting snippets see [`ryancerf/choss-maven-plugin`](https://github.com/ryancerf/choss-maven-plugin).

0 commit comments

Comments
 (0)