[DOCS-17] Merge the currently THREE separate Getting Started documents Created: 14/Apr/16  Updated: 23/Feb/18  Resolved: 01/Nov/16

Status: Resolved
Project: docs
Component/s: Getting Started Guide
Affects Version/s: Beryllium
Fix Version/s: None

Type: Bug
Reporter: Michael Vorburger Assignee: Phil Robb
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All


External issue ID: 5727

 Description   

Why do we have 3 separate Getting Started documents? How about merging them into 1?

1. https://www.opendaylight.org/installing-opendaylight (where is the source for that and how does one contribute to it?)

2. https://docs.google.com/document/d/12O86Nc4IbHvBC_ZGE_tHl0IWYd75Lk2HzfcV4YxhWTg/pub

3. https://github.com/opendaylight/docs/blob/master/manuals/getting-started-guide/src/main/asciidoc/bk-getting-started-guide.adoc (I'm assuming there is the HTML site of that? watch DOCS-16...)



 Comments   
Comment by Colin Dixon [ 17/Jun/16 ]

I agree. We actually have four. This is the one that should be considered authoritative:
https://opendaylight.readthedocs.io/en/latest/getting-started-guide/index.html

It's source lives here:
https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=tree;f=docs/getting-started-guide;hb=HEAD

Comment by Colin Dixon [ 30/Jun/16 ]

This is done for Boron here:
https://git.opendaylight.org/gerrit/#/q/topic:gsg2rst

For stable/beryllium, we have this:
https://git.opendaylight.org/gerrit/#/q/topic:be-rst-gsg

Those now for what should be the canonical version of the getting started guide. The next step is to garbage collect the others.

  • The github one should be garbage collected when the patches above are merged.
  • 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.
  • Then, we need to ask the web team to change this to point there as well: https://www.opendaylight.org/introduction-getting-started-guide
Comment by Colin Dixon [ 01/Jul/16 ]

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:
https://www.opendaylight.org/introduction-getting-started-guide

Comment by Colin Dixon [ 08/Sep/16 ]

Phil, fixing the last one here is on you.

Comment by Colin Dixon [ 01/Nov/16 ]

Casey says all links to this have been purged:
https://www.opendaylight.org/installing-opendaylight

It also renders as access denied now.

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