Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Existing Javadocs for pre-Apache NetBeans releases are hosted at the bits.netbeans.org domain, eg. http://bits.netbeans.org/8.2/javadoc/ We need to provide browse-able and download-able hosting of Javadocs for Apache releases, while keeping the existing Javadocs available via Oracle infrastructure (at least in the short term).


Please see netbeans-javadoc and maven utilities

Hosted Javadoc

Given the size of the Javadocs, and current limitations of the JBake build system with non-templated content, it is probably better to keep the hosted Javadocs separately from the main website build system  (at least for now).

The proposal is to host the Javadocs in a separate git repository with associated gitpubsub site at http://bits.netbeans.org  Non existing links (404s) should proxy through to the existing Oracle hosted server for earlier Javadocs, Maven, etc.  similar to the plan for the main netbeans.org website.

NOTE: Infra says the "standard" way is to host javadoc in a git repository, then use the "asf-site" branch and gitpubsub for publishing.

A new git repository will be requested at incubator-netbeans-website-docs (docs better than bits as other things there will likely end up elsewhere / eventually move it to docs.netbeans.org?)

NOTE: Infra suggest using http://selfserve.apache.org/ to create the repository ourselves. We may then open a JIRA ticket for setting up the asf-site/gitpubsub setup.

In the short term, Javadoc should be manually committed for each Apache release.  We can look at automating that, and potentially a dev snapshot, as a second step.

NOTE: We can create a Jenkins job (similar to the incubator-netbeans-website Jenkins job) to publish javadoc.

Javadoc downloads

The Javadoc zip download should be made available via the Apache mirror system, next to the existing source and binary downloads.

The current Jenkins release build system should probably be enhanced to build Javadoc artefacts alongside the source and binary downloads.