Dvc.org: docs: move /get-started index to root and /install above /get-started

Created on 26 Oct 2019  路  3Comments  路  Source: iterative/dvc.org

(Probably after #738)

I like that Get Started is the first section in our docs, but its 2nd page links to Installation for the user to go and figure out how to best install the tool. This may kind of break the continuity of get-started from the very beginning. Perhaps if we have Installation on top in the left side bar, most users will already have DVC installed by the time they get to the Get Started -> Initialize page.

doc-content enhancement good first issue priority-p1

Most helpful comment

From https://github.com/iterative/dvc.org/pull/734#issuecomment-546538772:

had to revert it back since it affected the way dvc.org/doc (main page) looks like. Before it was using Get Started index as a default one and it was crafted to look nice and it makes sense to start with get started :) Install index page is not ready to be a front page for the docs website. Need more work here.

Good point @shcheklein, https://dvc.org/doc/get-started has introductory notes to the entire docs. So maybe these should be moved into a docs/index.md to open as a docs landing page? And then move install above get-started.

All 3 comments

From https://github.com/iterative/dvc.org/pull/734#issuecomment-546538772:

had to revert it back since it affected the way dvc.org/doc (main page) looks like. Before it was using Get Started index as a default one and it was crafted to look nice and it makes sense to start with get started :) Install index page is not ready to be a front page for the docs website. Need more work here.

Good point @shcheklein, https://dvc.org/doc/get-started has introductory notes to the entire docs. So maybe these should be moved into a docs/index.md to open as a docs landing page? And then move install above get-started.

yep, good idea, @jorgeorpinel ! Then we can make Agenda in the Get Started to be an index page of the Get Started itself.

Probably some changes to the engine are required to make it work.

it makes sense to start with get started :)

If the user clicks the "Get Started" button, then it will go to the get-started, no matter whether it is the first item on the menu or the second. However if he clicks the "DOC" link to go to the UG or Command Reference, then he still gets Get Started (expanded), which effectively hides the rest of the docs.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

elleobrien picture elleobrien  路  4Comments

kurianbenoy picture kurianbenoy  路  5Comments

pared picture pared  路  4Comments

efiop picture efiop  路  5Comments

nisarhassan12 picture nisarhassan12  路  3Comments