You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: Paths are all relative to the root of the project.
6
8
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.
9
10
10
11
2) src files (java) that hold the compiled code (can be anywhere in the project, but are generally in `docs-src/src/`)
11
12
12
13
3) the output of running snippets in the src files. E.G. the output of running `table.first(10)`
13
14
14
15
4) The built docs that have not necessarily released are in `docs-src/dist/`
15
16
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)
19
18
20
-
### To update the Docs
19
+
### Rebuilding and deploying the docs
21
20
22
21
1) Navigate to the `./docs-src` sub directory (Where POM is located).
23
22
@@ -32,10 +31,8 @@ This will inject snippets into content files and copy everything the content to
32
31
4) To deploy the docs run the shell script `./deploy_docs.sh`.
33
32
34
33
* 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.
38
35
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