Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Extended documentation for deploying API docs

...

For each version we deploy the aggregated javadoc for for the Sling bundles contained in the launchpad. The javadoc  can be generated using the generate_javadoc_for_release.sh script. The script picks up artifacts from the Starter file, and manually adds others which we consider required, such as annotations. Any additional artifacts should be manually added to the script.

After generating the artifacts these should be copied in the sling-site repository, under src/main/jbake/assets/apidocs/sling${VERSION} and referenced from:

  • the sidebar ( src/main/jbake/templates/menu.tpl )
  • the API docs page ( src/main/jbake/content/documentation/apidocs.md )


For Sling 11 the javadoc deployment has failed once with an error similar to "Argument list too long". However, a second build allowed the publish to continue and succeeded. The key is to not invoke Maven with the clean phase, as the progress would be wiped.

Deploy the docker image on DockerHub

...