[DOCS-16] docs.opendaylight.org Created: 14/Apr/16 Updated: 19/Oct/17 Resolved: 08/Jul/16 |
|
| Status: | Resolved |
| Project: | docs |
| Component/s: | Toolchain |
| Affects Version/s: | Beryllium |
| Fix Version/s: | None |
| Type: | Bug | ||
| Reporter: | Michael Vorburger | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Environment: |
Operating System: All |
||
| External issue ID: | 5726 |
| Description |
|
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? |
| Comments |
| Comment by Thanh Ha (zxiiro) [ 14/Apr/16 ] |
|
Hi Michael, FWIW we're investigating ReadTheDocs at the moment and have some test pages up here: https://opendaylight.readthedocs.org/en/latest/ If things workout with readthedocs we can definitely add a DNS rule for docs.opendaylight.org for that URL so that you can go to the expected URL but it's still too early for that as all we're doing is testing right now. What's nice about readthedocs is it gives us automatic pdf and epub generation and tracks when a version of documentation is too old and notifies the user. |
| Comment by Colin Dixon [ 17/Jun/16 ] |
|
We're working on that. I'm not sure if we're going to make docs.opendaylight.org point to the readthedocs or this wiki page which would then go the right places: https://wiki.opendaylight.org/view/Docucentral |
| Comment by Colin Dixon [ 08/Jul/16 ] |