[DOCS-16] docs.opendaylight.org

Thu, 19 Oct 2017 21:28:21 +0000

I think it would be nice/useful/great is we automatically served up the *.adoc documentation for all manuals/ from the docs git repo at https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=tree;f=manuals;hb=HEAD on http://docs.opendaylight.org (or https://docs.opendaylight.org if we are going all SSL in general).

Wiki pages, and perhaps more importantly the intro/landing Drupal CMS pages on www.opendaylight.org incl. https://www.opendaylight.org/downloads, could just link into docs.opendaylight.org instead of those linked to fixed PDFs on Google Drive which we currently have.

I would expect URLs on docs.opendaylight.org to be reasonably stable, and I would expect them to be release-based, so there would be something like a http://docs.opendaylight.org/beryllium/manuals/getting-started-guide/ kind of URL. (eclipse.org does this on https://www.eclipse.org/documentation/ with e.g. http://help.eclipse.org/mars/)

Perhaps this would be quite easy? Two components to this - 1. docs/ build & 2. serving it via HTTP. For 2. I'm not sure if Nexus can already do that, seeing e.g. https://nexus.opendaylight.org/content/sites/site/org.opendaylight.yangtools/beryllium/apidocs/index.html, and maybe with some Apache mod_rewrite for nicer URLs from new docs.opendaylight.com sub-domain? Not sure if such Nexus hosted web content gets probably spidered for indexing by Google? Else maybe just publish docs/manuals by copying the result of the build job onto static Apache / nginx / whatever?

Can I help with this in any way?

OpenDaylight JIRA

[DOCS-16] docs.opendaylight.org