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-17 docs <p>Why do we have 3 separate Getting Started documents? How about merging them into 1?</p> <p>1. <a href="https://www.opendaylight.org/installing-opendaylight" class="external-link" target="_blank" rel="nofollow noopener">https://www.opendaylight.org/installing-opendaylight</a> (where is the source for that and how does one contribute to it?) </p> <p>2. <a href="https://docs.google.com/document/d/12O86Nc4IbHvBC_ZGE_tHl0IWYd75Lk2HzfcV4YxhWTg/pub" class="external-link" target="_blank" rel="nofollow noopener">https://docs.google.com/document/d/12O86Nc4IbHvBC_ZGE_tHl0IWYd75Lk2HzfcV4YxhWTg/pub</a> </p> <p>3. <a href="https://github.com/opendaylight/docs/blob/master/manuals/getting-started-guide/src/main/asciidoc/bk-getting-started-guide.adoc" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/opendaylight/docs/blob/master/manuals/getting-started-guide/src/main/asciidoc/bk-getting-started-guide.adoc</a> (I'm assuming there is the HTML site of that? watch <a href="https://jira.opendaylight.org/browse/DOCS-16" title="docs.opendaylight.org" class="issue-link" data-issue-key="DOCS-16"><del>DOCS-16</del></a>...)</p> <p>Operating System: All<br/> Platform: All</p> DOCS-17

Merge the currently THREE separate Getting Started documents

Bug Resolved Done Phil Robb Michael Vorburger Thu, 14 Apr 2016 11:59:58 +0000 Fri, 23 Feb 2018 17:17:14 +0000 Tue, 1 Nov 2016 19:05:36 +0000 Beryllium Getting Started Guide 0 2 <p>I agree. We actually have four. This is the one that should be considered authoritative:<br/> <a href="https://opendaylight.readthedocs.io/en/latest/getting-started-guide/index.html" class="external-link" target="_blank" rel="nofollow noopener">https://opendaylight.readthedocs.io/en/latest/getting-started-guide/index.html</a></p> <p>It's source lives here:<br/> <a href="https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=tree;f=docs/getting-started-guide;hb=HEAD" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=tree;f=docs/getting-started-guide;hb=HEAD</a></p> <p>This is done for Boron here:<br/> <a href="https://git.opendaylight.org/gerrit/#/q/topic:gsg2rst" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/q/topic:gsg2rst</a></p> <p>For stable/beryllium, we have this:<br/> <a href="https://git.opendaylight.org/gerrit/#/q/topic:be-rst-gsg" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/q/topic:be-rst-gsg</a></p> <p>Those now for what should be the canonical version of the getting started guide. The next step is to garbage collect the others.</p> <ul> <li>The github one should be garbage collected when the patches above are merged.</li> <li>I can change the google doc to point to the stable/beryllium guide on Read the Docs as soon as I get that stack of patches merged.</li> <li>Then, we need to ask the web team to change this to point there as well: <a href="https://www.opendaylight.org/introduction-getting-started-guide" class="external-link" target="_blank" rel="nofollow noopener">https://www.opendaylight.org/introduction-getting-started-guide</a></li> </ul> <p>The patches are now all merged and the Google doc is now a pointer to that. The only thing left to do is to get rid of the one hosted here:<br/> <a href="https://www.opendaylight.org/introduction-getting-started-guide" class="external-link" target="_blank" rel="nofollow noopener">https://www.opendaylight.org/introduction-getting-started-guide</a></p> <p>Phil, fixing the last one here is on you.</p> <p>Casey says all links to this have been purged:<br/> <a href="https://www.opendaylight.org/installing-opendaylight" class="external-link" target="_blank" rel="nofollow noopener">https://www.opendaylight.org/installing-opendaylight</a> </p> <p>It also renders as access denied now.</p> Development External issue ID 5727 External issue URL Rank 0|i01oxb: