-
Notifications
You must be signed in to change notification settings - Fork 406
Closed as not planned
Labels
good first issueGood for newcomersGood for newcomerstype: enhancementSomething is not clear, small updates, improvement suggestionsSomething is not clear, small updates, improvement suggestions
Description
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 featsUPDATE: 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/mdoptions (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/modifydetails from cmd ref. #2866 Maybeexp listvsexp showorexp showvsexp diffin 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
casperdclcasperdclcasperdcl
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomerstype: enhancementSomething is not clear, small updates, improvement suggestionsSomething is not clear, small updates, improvement suggestions