Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Place documentation contributors guide in more discoverable location #1268

Merged
merged 3 commits into from
Jan 3, 2025
Merged

Place documentation contributors guide in more discoverable location #1268

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a9c4b2
Place documentation contributors guide in more discoverable location
benmccann Jan 2, 2025
b809c49
fix codacy issue
benmccann Jan 2, 2025
8ec7943
tweak
benmccann Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions docs-src/README.md → CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
## Compiled Docs
# Contributing

## Documentation

There are several pieces that go into the docs.

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

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

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

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

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

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)

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)

### To update the Docs
### Rebuilding and deploying the docs

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

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

* This will copy the `docs-src/dist/` directory to `docs/`
* 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.
* 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.

### Notes
For more background on injecting snippets see:
https://github.com/ryancerf/choss-maven-plugin
### Notes

For more background on injecting snippets see [`ryancerf/choss-maven-plugin`](https://github.com/ryancerf/choss-maven-plugin).
Loading