Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move /get-started index to root and /install above /get-started #747

Closed
jorgeorpinel opened this issue Oct 25, 2019 · 3 comments · Fixed by #1051
Closed

docs: move /get-started index to root and /install above /get-started #747

jorgeorpinel opened this issue Oct 25, 2019 · 3 comments · Fixed by #1051
Labels
A: docs Area: user documentation (gatsby-theme-iterative) good first issue Good for newcomers p1-important Active priorities to deal within next sprints type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Oct 25, 2019

(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.

@jorgeorpinel jorgeorpinel added question A: docs Area: user documentation (gatsby-theme-iterative) labels Oct 25, 2019
@jorgeorpinel jorgeorpinel changed the title install: move section above get-started? install: move this section above get-started? Oct 25, 2019
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Oct 26, 2019

From #734 (comment):

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.

@shcheklein
Copy link
Member

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.

@dashohoxha
Copy link
Contributor

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.

@jorgeorpinel jorgeorpinel added website: eng-doc DEPRECATED JS engine for /doc good first issue Good for newcomers and removed question labels Oct 26, 2019
@jorgeorpinel jorgeorpinel changed the title install: move this section above get-started? docs: move get-started/index.md to root and move /install above get-started Oct 26, 2019
@jorgeorpinel jorgeorpinel removed the website: eng-doc DEPRECATED JS engine for /doc label Jan 4, 2020
@jorgeorpinel jorgeorpinel changed the title docs: move get-started/index.md to root and move /install above get-started docs: move get-started/index to root and /install above get-started Jan 4, 2020
@jorgeorpinel jorgeorpinel changed the title docs: move get-started/index to root and /install above get-started docs: move /get-started index to root and /install above /get-started Jan 4, 2020
@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions p1-important Active priorities to deal within next sprints and removed get-started labels Jan 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) good first issue Good for newcomers p1-important Active priorities to deal within next sprints type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants