how: new (sub)section (How To's)

[jorgeorpinel]

It seems from several open issues that we may need a section or subsection somewhere in the docs to provide certain "how to" guides. For example, these are the issues with "how to" in their titles atm:

UPDATE: See https://documentation.divio.com/how-to-guides/#how-to

• Organize existing how-to material into the new section (some may be under guides now).
• explain how to "undo" 'dvc add' + other "how to undo mistakes" recipes how to: "undo" 'dvc add' + other "how to undo mistakes" recipes #625
• commit: add example on how to add missing dependency to existing pipeline cmd ref: add commit example on adding missing dependency to existing pipeline #612
• how to update tracked directories (part of add: new files to tracked directories #3297)
• how: use custom certs on s3 compatible remote storage #1079 ?

Other ideas:

• search old "how to" questions in dvc repo e.g. how to return back to an older version of data dvc#599, forum, etc.
• cmd ref: improve run and commit / how to add output without re-running stage? cmd ref: improve run and commit / how to add outs/deps without re-running stage? #460
• "How to remove data" — what other ways to remove data (other than un-doing add) are there?
• "How to host a public DVC project" (private-write, public-read)
• "How to uninstall dvc" for both binary and pip packages how to: "uninstall dvc" for both binary and pip packages #65
• This Fix #563: How to keep data and cache on external drive #732 (review) discussion:

  we'll have to introduce a how to section soon... May be we can move things like "Running on Windows" into this section

• Also, this docs: locking-related updates #868 (review) comment:

  Parallel stage execution from the dvc repro cmd ref can be probably moved to a How to section, with a link to it from the cmd ref

• How tos on dvc init --no-scm usage? See user-guide: add info about --no-scm mode (and link from get-started) #100 (comment)

Let's analyze this list, look for any others, and see whether it makes sense to have a dedicated how-to section, or whether an existing section of the docs e.g. use-cases or specific command references or user guides can cover all of these.

[jorgeorpinel]

💡 If we do need this new section, perhaps it could live near the new Troubleshooting section (in User Guide, see PR #875).

[jorgeorpinel]

I made this search (https://stackoverflow.com/questions/tagged/dvc) to find a handful of questions that could be helpful in making a how-to guide.

Good idea. We can also review recent Monthly Gems blog posts e.g. https://dvc.org/blog/may-20-community-gems. But these small/specific questions are not enough for how-tos. We would need to find patterns among them and extrapolate larger how-to guides that cover most of these.

[jorgeorpinel]

There are issues for the couple check boxes left. Many of the other ideas are great but this should be done as we update existing docs (consider extracting how-to parts of guides/refs/etc into how-to section).