[DOCS-33] javadoc.opendaylight.org Created: 28/Feb/17  Updated: 28/Feb/18  Resolved: 28/Nov/17

Status: Open
Project: docs
Component/s: Developer Guide
Affects Version/s: unspecified
Fix Version/s: None

Type: Bug
Reporter: Michael Vorburger Assignee: Thanh Ha (zxiiro)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All


Issue Links:
Blocks
blocks DOCS-45 Java API documentation is missing Open
blocks RELENG-3 Javadocs are not being generated for ... Open
blocks ODLPARENT-108 javadoc.opendaylight.org++ e.g. with ... Resolved
blocks ODLPARENT-124 POC odlparent's JavaDoc on javadoc.op... Resolved
is blocked by RELENG-42 Produce JavaDoc site for entire release Open
is blocked by ODLPARENT-70 New odlparent Maven Profile / Parent ... Resolved
is blocked by RELENG-62 deploy-site.xml should wipe prior con... Resolved
External issue ID: 7874

 Description   

based on discussions rovarga, zxiiro and I just had on IRC:

we want a simple statically hosted http://javadocs.opendaylight.org kind of site.

ODLPARENT-70 and RELENG-42 (and maybe others, see Depends on) are pre-reqs for this end goal.

This MAY go through a (new?) ODL intermediate git repo, to be served by readthedocs.



 Comments   
Comment by Thanh Ha (zxiiro) [ 14/Oct/17 ]

We can use URL rewriting here to map http://javadoc.opendaylight.org/PROJECT_SHORTNAME to https://nexus.opendaylight.org/content/repositories/javadoc/org.opendaylight.PROJECT_SHORTNAME

One thing we need to consider is how to handle subprojects like honeycomb/vbd

will the shortname for vbd be honeycomb.vbd?

I opened https://jira.linuxfoundation.org/browse/RELENG-578 internally to get this done.

Comment by Michael Vorburger [ 16/Oct/17 ]

> We can use URL rewriting here to map

when you say "URL rewriting", does that mean (a) "internal" as in you would have an Apache/Nginx/whatever front-end on javadoc.opendaylight.org, or (b) "external" as in a HTTP 3xx Redirect?

Am asking because the requirement that I had in mind but on re-reading this realize perhaps was not spelt out clearly enough above is that such a new javadoc.opendaylight.org site really should be crawlable by Gogole & friends' robots (which nexus.opendaylight.org is not) ... perhaps you could, eventually, even register it on https://www.google.com/webmasters/tools ?

> One thing we need to consider is how to handle subprojects like honeycomb/vbd
> will the shortname for vbd be honeycomb.vbd?

I think that would be just fine.

> opened RELENG-578

Tx! Watching that...

Comment by Thanh Ha (zxiiro) [ 09/Nov/17 ]

This is complete and https://javadocs.opendaylight.org now exists. It can be used in 2 ways:

1. via https://javadocs.opendaylight.org/PROJECT_SHORTNAME
2. via https://javadocs.opendaylight.org/FQDN

eg:

https://javadocs.opendaylight.org/controller
https://javadocs.opendaylight.org/org.opendaylight.controller

Generated at Wed Feb 07 19:58:29 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.