Dear community,

As you may know the website (https://bookkeeper.apache.org) is not updated
to the latest releases (the latest changes have occurred almost a year ago).
Also the Javadoc is missing for all the released versions. (
https://bookkeeper.apache.org/docs/4.14.0/api/javadoc for example).

I identified several problems:
1. The website deployment is broken. IIUC the website should be deployed
whenever a new commit occurs in the 'asf-site' branch (
https://github.com/apache/bookkeeper/tree/asf-site). I think, but I may be
wrong, that there is an old Travis configuration somewhere in the ASF infra
that builds and deploys the website. Since Travis is no longer used, we
should move to use the .asf.yaml file (
https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features).
2. Javadocs are not present for any release. This is very ugly. I don't
know the cause. We "forgot" to port the Javadoc aggregated generation to
Gradle, so currently, for 4.15.0 the problem is not easily addressable.
3. The doc is outdated/wrong. There are code samples with old/deprecated
API as pointed out by a user a few days ago.
4. There was an initial effort to migrate the documentation engine to
Docusaurus (under site2/). The work has never been finished. There are a
couple of things that are missing:
* Releases docs
* Multiple pages
https://github.com/apache/bookkeeper/pull/2426


Now, some solutions/opinions:
1. I created this PR to perform the migration:
https://github.com/apache/bookkeeper/pull/3080
2. I restored the javadoc generation for Gradle here:
https://github.com/apache/bookkeeper/pull/3081. I also added a daily job
which is supposed to build and deploy the website (if something has
changed). I'm not able to try it out but it should work.
4. I'm planning to send a PR in the next few days to complete the work and
drop the old site engine. However, steps 1 and 2 are required to stabilize
the situation and then move forward. Do you agree we should continue with
Docusaurus?

Please let me know if I am missing something and your overall opinion.

BR,
Nicolò Boschi

Reply via email to