docs: apply more language tabs

[jorgeorpinel]

Follow up to #759

Per tabs system introduced in #2914

Usage

<!-- /some/page.md -->
<toggle>
<tab title="Foo">

some text about Foo

</tab>
<tab title="Bar">

some text about Bar

</tab>
</toggle>

• Put this usage (and other special features) in https://dvc.org/doc/user-guide/contributing/docs ? Coincidentally, we could use tabs to list the special feats UPDATE: Document engine features #3506

---

Places where we can use them

Main use

• Upgrade Linux-specific terminal/shell or code samples to cover Windows too.
• Installation page sections https://dvc.org/doc/install
• start: update command blocks with tabs for Windows  #3311
• Throughout for params in different formats (guides, refs)
• Throughout for metrics/plots in different formats (guides, refs)
• Throughout for some --json/csv/md options (guides, refs.)

Other ideas (exploratory)

• Throughout (some) examples of https://dvc.org/doc/user-guide/project-structure/pipelines-files to show writing dvc.yaml vs. using stage add -- +& related guides/refs. (ex)
• To show different ways for Registering checkpoints (currently only DVCLive is shown, not signal files/make_checkpoint()).
• Try in Examples of https://dvc.org/doc/user-guide/external-dependencies and https://dvc.org/doc/user-guide/managing-external-data (and https://dvc.org/doc/user-guide/contributing/core#testing-remotes)
• Try in https://dvc.org/doc/user-guide/what-is-dvc#core-features and/or https://dvc.org/doc/user-guide/related-technologies (pages could be merged)
• Try for the feature highlights in https://dvc.org/doc/use-cases/ci-cd-for-machine-learning -- make the page shorter/cleaner
• Try in subsections of https://dvc.org/doc/use-cases/data-registries#using-registries
• Maybe for Experiment Tracking tool comparison (instead of table)
• Note: may be useful for guide: extract remote add/modify details from cmd ref. #2866
• Maybe exp list vs exp show or exp show vs exp diff in Comparing Exps? Per needs of guide: "Comparing Experiments" improvements #2995
• Maybe for .dvc/tmp/ subfolders in https://dvc.org/doc/user-guide/project-structure/internal-files
• Maybe Modify vs Update sections in https://dvc.org/doc/user-guide/how-to/update-tracked-data
  And metafiles in https://dvc.org/doc/user-guide/how-to/merge-conflicts
• Maybe GC project vs service accounts in https://dvc.org/doc/user-guide/setup-google-drive-remote
• Maybe file linking methods in https://dvc.org/doc/user-guide/large-dataset-optimization

[iesahin]

Per OS instructions?

AWS etc. remote types?

[daavoo]

I see the several dvc exp show flags #2877 as a good candidate for this format

[jorgeorpinel]

Per OS instructions?

Yes but where? Or where first?

the several dvc exp show flags #2877 as a good candidate

Good idea, added to the list. Maybe not the most obvious or necessary though since those are actually different features, but it can surely help shorten some docs if needed.

[jorgeorpinel]

Note: I updated the description with the list I came up with (forgot to let you all know earlier).

Try for the feature highlights in https://dvc.org/doc/use-cases/ci-cd-for-machine-learning

WDYT @casperdcl ?

Maybe exp list vs exp show or exp show vs exp diff in Comparing Exps? Per needs of #2995

WDYT @iesahin ?

To show different ways to Registering checkpoints

WDYT @flippedcoder ?

[shcheklein]

What about Windows/Linux for code snippets - do we have this item in the list?

(seems the most obvious in DVC case)

[jorgeorpinel]

What about Windows/Linux for code snippets

Good point. I didn't list that since we try to have pretty generic console samples but I'm sure lots of them are still very POSIX/GNU-specific. Added a top checkbox to review them and apply tabs where/if needed.

[jorgeorpinel]

Cc @tapadipti any places you think this could help condense https://dvc.org/doc/studio pages? E.g. any lists of anything that represent alternatives for some end could be candidates. Thanks

[iesahin]

Maybe exp list vs exp show or exp show vs exp diff in Comparing Exps? Per needs of #2995

WDYT @iesahin ?

These commands are not "identical" in the sense that when you learn/use one, the other becomes obsolete. The use cases that we can employ these commands alternatively are limited. Also, our hidden content in other places causes confusion sometimes. I don't want these to be hidden behind tabs.

[jorgeorpinel]

OK let's just keep it in mind as a possible way to make some sections shorted AFTER each command has been introduced and only if different commands are used as precise alternatives for some task/example.

[iesahin]

IMO, we should limit tabs to:

• Same commands in different shells/OSes
• Same function in different languages/frameworks (e.g. DVCLive/checkpoints usage in Keras/PyTorch/...)

It's rare to have such uses in basic DVC commands, e.g., it's possible to get the list of remote experiments with ˋdvc exp showˋ but we normally use ˋdvc exp listˋ for this.

[tapadipti]

Cc @tapadipti any places you think this could help condense https://dvc.org/doc/studio pages? E.g. any lists of anything that represent alternatives for some end could be candidates. Thanks

I just skimmed through the Studio docs, and currently I do not see sections with alternates that are suitable for placing in tabs, coz the Studio commands/instructions are the same across all platforms/OSes/etc. However, I think that as the doc evolves, there will be sections that can utilize tabs. Thanks @jorgeorpinel for tagging me.

[jorgeorpinel]

IMO, we should limit tabs to...

OK. I'd generalize this rule of thumb to something you mentioned elsewhere @iesahin : Any list of alternatives where the reader only needs to see one (a clear favorite) to get the point. This probably means code/terminal examples 90% of the time at least but who knows, other situations may apply.

I updated the list in the description per this rule.

[shcheklein]

Should we put summary of this into the docs contributing guide (also update it to describe how do these tabs in the Markdown)?

[jorgeorpinel]

That is also a check box in the description @shcheklein 😬

[jorgeorpinel]

Throughout Get Started code snippets (e.g. #3215)

Cc @iesahin