cmd ref: remove unnecessary indices?

[jorgeorpinel]

Blocked by #891

Closes #727

[jorgeorpinel]

So... #891 was only really for the contribution guide 😋 (from #903 (comment))

Actually, on this @shcheklein what about my #727 (comment) about cmd ref indices?

• https://dvc.org/doc/command-reference/cache,
• https://dvc.org/doc/command-reference/metrics,
• https://dvc.org/doc/command-reference/pipeline, and
• https://dvc.org/doc/command-reference/remote

have useful, unique content but I'm not sure the cmd ref is the best place for those explanations. Should we take the opportunity to move them into a new user-guide: "Basic Concepts" (#550)?

Removing them would mean that the first subcommand opens by default though. For cache -> cache/dir (good), for metrics and remote -> */add, and for pipeline -> pipeline/list

[shcheklein]

@jorgeorpinel hmm ... I think they are valuable. Not matter what, but dvc remote -h is a legit command by itself and should be described. Or in the future we can decide to make dvc remote an alias of dvc remote list?

[jorgeorpinel]

Yes, they have valuable content explaining what the concepts are (cache, metrics, pipeline, remote). My point is that such content probably doesn't belong in the command reference and we can move it to a new user-guide: "Basic Concepts" (per #550) – and once that is done, it won't make sense to keep these indices.

Should they just be a short list of links to their subcommands? Or remove completely and let the first one load. I think at least for dvc cache since it only has dir inside, we should just remove the index.

[shcheklein]

@jorgeorpinel dvc remote, dvc cache, etc are valid commands. So I think they belong to the command reference and should have more or less the same structure.

[jorgeorpinel]

dvc remote, dvc cache, etc are valid commands

Ah yes good point. Didn't think about that. So we definitely need the indices. OK! This PR is now officially reviewable!

p.s. but please note that I've extracted the discussion about moving concepts explanations out of the cmd ref to #550 (comment).

[shcheklein]

LGTM 👍 😎