https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/DOCS-33 docs <p>based on discussions rovarga, zxiiro and I just had on IRC:</p> <p>we want a simple statically hosted <a href="http://javadocs.opendaylight.org" class="external-link" target="_blank" rel="nofollow noopener">http://javadocs.opendaylight.org</a> kind of site.</p> <p><a href="https://jira.opendaylight.org/browse/ODLPARENT-70" title="New odlparent Maven Profile / Parent / whatever-it-takes to be able to build a JavaDoc site" class="issue-link" data-issue-key="ODLPARENT-70"><del>ODLPARENT-70</del></a> and <a href="https://jira.opendaylight.org/browse/RELENG-42" title="Produce JavaDoc site for entire release" class="issue-link" data-issue-key="RELENG-42">RELENG-42</a> (and maybe others, see Depends on) are pre-reqs for this end goal.</p> <p>This MAY go through a (new?) ODL intermediate git repo, to be served by readthedocs.</p> <p>Operating System: All<br/> Platform: All</p> DOCS-33

javadoc.opendaylight.org

Bug Open Done Thanh Ha (zxiiro) Michael Vorburger Tue, 28 Feb 2017 20:50:01 +0000 Wed, 28 Feb 2018 15:56:05 +0000 Tue, 28 Nov 2017 15:21:47 +0000 unspecified Developer Guide 0 2 <p>We can use URL rewriting here to map <a href="http://javadoc.opendaylight.org/PROJECT_SHORTNAME" class="external-link" target="_blank" rel="nofollow noopener">http://javadoc.opendaylight.org/PROJECT_SHORTNAME</a> to <a href="https://nexus.opendaylight.org/content/repositories/javadoc/org.opendaylight.PROJECT_SHORTNAME" class="external-link" target="_blank" rel="nofollow noopener">https://nexus.opendaylight.org/content/repositories/javadoc/org.opendaylight.PROJECT_SHORTNAME</a></p> <p>One thing we need to consider is how to handle subprojects like honeycomb/vbd</p> <p>will the shortname for vbd be honeycomb.vbd?</p> <p>I opened <a href="https://jira.linuxfoundation.org/browse/RELENG-578" class="external-link" target="_blank" rel="nofollow noopener">https://jira.linuxfoundation.org/browse/RELENG-578</a> internally to get this done.</p> <p>&gt; We can use URL rewriting here to map </p> <p>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? </p> <p>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 &amp; friends' robots (which nexus.opendaylight.org is not) ... perhaps you could, eventually, even register it on <a href="https://www.google.com/webmasters/tools" class="external-link" target="_blank" rel="nofollow noopener">https://www.google.com/webmasters/tools</a> ?</p> <p>&gt; One thing we need to consider is how to handle subprojects like honeycomb/vbd<br/> &gt; will the shortname for vbd be honeycomb.vbd?</p> <p>I think that would be just fine.</p> <p>&gt; opened RELENG-578</p> <p>Tx! Watching that...</p> <p>This is complete and <a href="https://javadocs.opendaylight.org" class="external-link" target="_blank" rel="nofollow noopener">https://javadocs.opendaylight.org</a> now exists. It can be used in 2 ways:</p> <p>1. via <a href="https://javadocs.opendaylight.org/PROJECT_SHORTNAME" class="external-link" target="_blank" rel="nofollow noopener">https://javadocs.opendaylight.org/PROJECT_SHORTNAME</a><br/> 2. via <a href="https://javadocs.opendaylight.org/FQDN" class="external-link" target="_blank" rel="nofollow noopener">https://javadocs.opendaylight.org/FQDN</a></p> <p>eg:</p> <p><a href="https://javadocs.opendaylight.org/controller" class="external-link" target="_blank" rel="nofollow noopener">https://javadocs.opendaylight.org/controller</a><br/> <a href="https://javadocs.opendaylight.org/org.opendaylight.controller" class="external-link" target="_blank" rel="nofollow noopener">https://javadocs.opendaylight.org/org.opendaylight.controller</a></p> Blocks DOCS-45 RELENG-3 ODLPARENT-108 ODLPARENT-124 RELENG-42 ODLPARENT-70 RELENG-62 Development External issue ID 7874 External issue URL Issue Type Rank 0|i01p0v: