wuchong commented on PR #1724:
URL: https://github.com/apache/fluss/pull/1724#issuecomment-3315993892
Thanks for the great work @MehulBatra !
Here are my thoughts about the javadoc design:
1. I don't want to maintain the generated javadoc in the main repo and
branches, this will quickly increase our main repo size. which is very heavy.
2. We can maintain each generated javadocs at the `apache/fluss-website` in
the branches `javadoc-<version>`.
3. We need to maintain javadocs for each version, including the released
(not include the `com.alibaba.fluss` versions) and unreleased (`main` branch).
Here are suggestions about how to implement:
1. Create a new script `build_javadocs.sh` under `website/` along with
`build_versioned_docs.sh`
- The script just generates javadocs for the current branch, the generated
javadocs can be put in the folder `website/genearted_javadocs/` (add this
directory into `.gitignore`)
2. Add a `build_javadocs.yaml` in apache/fluss-website
https://github.com/apache/fluss-website/tree/main/.github/workflows
- it's a daily scheduled github action
- it checkout apache/fluss repo and for each `release-*` (exclude <=
`release-0.7` branches) and `main` branch
- for each branch, it runs the `build_javadocs.sh` script and commit the
files in `website/genearted_javadocs/` to the branch `javadoc-<version>`
- maybe we can skip branches if the branch has no git log changes in 7
days, to reduce the build cost.
3. Update `website-deploy.yaml` in apache/fluss-website, add a step `Copy
Javadocs` before the `Deploy website`.
- it copies javadocs files from branches `javadoc-<version>` to the
directory `./build/javadoc/<version>`
- you can learn the code from `build_versioned_docs.sh` in apache/fluss
which has similar code.
4. Add javadoc links in our official docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
