[
https://issues.apache.org/jira/browse/CASSJAVA-109?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18019488#comment-18019488
]
Jane He commented on CASSJAVA-109:
----------------------------------
Process to build the docs for multiple versions
I like to set up three directories
1. `java-driver` on the 4.x branch
2. `doc-java-driver` that has the following folder structure
```
docs
4.18.0
4.18.1
4.19.1
README.md
out
mkdocs.yml
```
The mkdocs.yml
```yml
site_name: Java Driver for Apache Cassandra
site_description: Java Driver for Apache Cassandra® Documentation
site_url: https://apache.github.io/cassandra-java-driver
repo_url: https://github.com/apache/cassandra-java-driver
repo_name: apache/cassandra-java-driver
docs_dir: docs
site_dir: out
theme:
name: material
palette:
- scheme: default
primary: blue
accent: blue
features:
- navigation.tabs
- navigation.sections
- navigation.top
- search.highlight
- search.share
markdown_extensions:
- admonition
- codehilite
- pymdownx.superfences
- pymdownx.tabbed
- toc:
permalink: true
nav:
- Versions: README.md
plugins:
- search
- awesome-pages
```
The `docs/README.md`
```
# Java Driver for Apache Cassandra
Please find the documentation for the following versions:
- [4.19.0](4.19.0/index.html)
- [4.18.1](4.18.1/index.html)
- [4.18.0](4.18.0/index.html)
```
3. `gh-pages-java-driver` for the java driver on `gh-pages` branch
### Steps
In `java-driver` folder
1. Squash the commits about `mkdocs` and other build processes into one.
Currently it's `c06791dd8cc29bc06f65a66b0b92ab6e3f9ee5f1` for me on my [branch
](https://github.com/SiyaoIsHiding/java-driver/tree/doc)
2. Checkout to the version you want to build doc on `git checkout 4.18.0`
3. `git cherry-pick c06791dd8cc29bc06f65a66b0b92ab6e3f9ee5f1`
4. `./build-doc.sh`
5. `cp -r docs/ ../doc-java-driver/docs/4.18.0`
In `doc-java-driver` folder
1. `mkdocs serve` to preview
2. `mkdocs build`
In `gh-pages-java-driver` folder
1. `git rm -rf .` to clean existing doc
2. `cp -r ../doc-java-driver/out/ .`
> Building and Hosting Manual and API references after being donated to ASF
> -------------------------------------------------------------------------
>
> Key: CASSJAVA-109
> URL: https://issues.apache.org/jira/browse/CASSJAVA-109
> Project: Apache Cassandra Java driver
> Issue Type: Task
> Components: Documentation
> Reporter: Jane He
> Assignee: Jane He
> Priority: Normal
> Time Spent: 3h 10m
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
