diff --git a/content/docs/dvclive/api-reference/live/set_step.md b/content/docs/dvclive/api-reference/live/set_step.md index 72a43577de..bac5c8df30 100644 --- a/content/docs/dvclive/api-reference/live/set_step.md +++ b/content/docs/dvclive/api-reference/live/set_step.md @@ -1,4 +1,4 @@ -# dvclive.set_step() +# Live.set_step() Signals that the current step has ended and sets step to the given value. diff --git a/content/docs/dvclive/ml-frameworks/huggingface.md b/content/docs/dvclive/ml-frameworks/hugging-face.md similarity index 100% rename from content/docs/dvclive/ml-frameworks/huggingface.md rename to content/docs/dvclive/ml-frameworks/hugging-face.md diff --git a/content/docs/install/completion.md b/content/docs/install/completion.md index 2e10e41101..d54169692d 100644 --- a/content/docs/install/completion.md +++ b/content/docs/install/completion.md @@ -1,4 +1,4 @@ -# Shell Tab Completion +# Shell Completion Enjoy working with DVC faster and with fewer typos! diff --git a/content/docs/install/index.md b/content/docs/install/index.md index c1112e116d..36e781fcb9 100644 --- a/content/docs/install/index.md +++ b/content/docs/install/index.md @@ -1,4 +1,4 @@ -# Installation +# Install DVC > Please double check that you don't already have DVC (for example running > `which dvc`) before trying to install it. diff --git a/content/docs/install/linux.md b/content/docs/install/linux.md index 1e9de57f9f..a745ca57b9 100644 --- a/content/docs/install/linux.md +++ b/content/docs/install/linux.md @@ -1,9 +1,9 @@ -# Installation on Linux +# Install on Linux > To use DVC [as a Python library](/doc/api-reference), please > [install with pip](#install-with-pip) or [with conda](#install-with-conda). -## Install with pip +## With Pip > 💡 We **strongly** recommend creating a > [virtual environment](https://python.readthedocs.io/en/stable/library/venv.html) @@ -39,7 +39,7 @@ In this case it installs the `boto3` library along with DVC. > installation. If restarting the terminal isn't desirable (e.g. containers), > it's also possible to manually edit the `PATH` env variable. -## Install with conda +## With Conda > Requires [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or > [Anaconda Distribution](https://docs.anaconda.com/anaconda/). @@ -66,7 +66,7 @@ In this case it installs the `boto3` library along with DVC. -## Install with snap +## With Snapcraft > Requires [snapd](https://snapcraft.io/docs/installing-snapd). @@ -77,7 +77,7 @@ $ snap install --classic dvc > 💡 When connected to the internet, `snap` will automatically look for updates > every 6 hours. -## Install from repository +## From repository
@@ -109,7 +109,7 @@ $ sudo yum install dvc
-## Install from package +## From package Get the binary package from the big "Download" button on the [home page](/), or from the [release page](https://github.com/iterative/dvc/releases/) on GitHub. diff --git a/content/docs/install/macos.md b/content/docs/install/macos.md index e209f4e9af..91474e200b 100644 --- a/content/docs/install/macos.md +++ b/content/docs/install/macos.md @@ -1,9 +1,9 @@ -# Installation on macOS +# Install on macOS > To use DVC [as a Python library](/doc/api-reference), please > [install with pip](#install-with-pip) or [with conda](#install-with-conda). -## Install with brew +## With Homebrew Recommended. Requires [Homebrew](https://brew.sh/). @@ -11,7 +11,7 @@ Recommended. Requires [Homebrew](https://brew.sh/). $ brew install dvc ``` -## Install from package +## From package Get the PKG (binary) from the big "Download" button on the [home page](/), or from the [release page](https://github.com/iterative/dvc/releases/) on GitHub. @@ -24,7 +24,7 @@ from the [release page](https://github.com/iterative/dvc/releases/) on GitHub. > You may try [these instructions](https://stackoverflow.com/a/42120328/761963) > to uninstall the macOS package. -## Install with pip +## With Pip > 💡 We **strongly** recommend creating a > [virtual environment](https://python.readthedocs.io/en/stable/library/venv.html) @@ -55,7 +55,7 @@ In this case it installs the `boto3` library along with DVC. -## Install with conda +## With Conda > Requires [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or > [Anaconda Distribution](https://docs.anaconda.com/anaconda/). diff --git a/content/docs/install/plugins.md b/content/docs/install/plugins.md index fe9dab3111..dba31301a6 100644 --- a/content/docs/install/plugins.md +++ b/content/docs/install/plugins.md @@ -1,4 +1,4 @@ -# IDE Plugins and Syntax Highlighting +# Plugins for IDEs (Syntax Highlighting) When files or directories are added to the project, or stages to a pipeline, DVC files are created or updated. These use a simple YAML format. diff --git a/content/docs/install/pre-release.md b/content/docs/install/pre-release.md index 49361552b2..2be0d3c701 100644 --- a/content/docs/install/pre-release.md +++ b/content/docs/install/pre-release.md @@ -1,7 +1,7 @@ # Install Pre-release Version -If you want to test the latest stable version of DVC, ahead of official -releases, you can install it from our code repository GitHub. +If you want to test the latest stable version of DVC ahead of official releases, +you can install it from our GitHub code repository. > We **strongly** recommend creating a > [virtual environment](https://python.readthedocs.io/en/stable/library/venv.html) diff --git a/content/docs/install/windows.md b/content/docs/install/windows.md index 1b99ce91e1..b65b2f36dc 100644 --- a/content/docs/install/windows.md +++ b/content/docs/install/windows.md @@ -1,4 +1,4 @@ -# Installation on Windows +# Install on Windows > 💡 Please review > [Running DVC on Windows](/doc/user-guide/running-dvc-on-windows) for important @@ -7,9 +7,9 @@ > To use DVC [as a Python library](/doc/api-reference), please > [install with pip](#install-with-pip) or [with conda](#install-with-conda). -## Install with choco +## With Chocolatey -The easiest way to install from command line for most cases is to install +The easiest way to install from command line for most cases is to get [Chocolatey](https://chocolatey.org/) on your machine, and use the `choco` command: @@ -17,7 +17,7 @@ command: $ choco install dvc ``` -## Install with conda +## With Conda > Requires [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or > [Anaconda Distribution](https://docs.anaconda.com/anaconda/). @@ -48,7 +48,7 @@ In this case it installs the `boto3` library along with DVC. -## Install with pip +## With Pip From Command Prompt or other [recommended consoles](/doc/user-guide/running-dvc-on-windows): diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json index b548f7b0a4..36ba5e004a 100644 --- a/content/docs/sidebar.json +++ b/content/docs/sidebar.json @@ -1,27 +1,25 @@ [ { "slug": "", - "label": "Home", - "source": "index.md", + "label": "DVC Docs Home", "icon": "house" }, { "slug": "install", - "source": "install/index.md", "children": [ { - "label": "macOS", - "slug": "macos" + "slug": "macos", + "label": "macOS" }, "windows", "linux", { - "label": "Pre-release Version", - "slug": "pre-release" + "slug": "pre-release", + "label": "Pre-release Version" }, { - "label": "Shell Completion", - "slug": "completion" + "slug": "completion", + "label": "Shell Completion" }, "plugins" ] @@ -29,33 +27,30 @@ { "slug": "start", "label": "Get Started", - "source": "start/index.md", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/get-started" }, "children": [ { "slug": "data-management", - "label": "Data Management", - "source": "data-management/index.md", "children": [ { - "label": "Data and Model Access", "slug": "access", + "label": "Data and Model Access", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/get-started/accessing" } }, { - "label": "Data Pipelines", "slug": "pipelines", + "label": "Data Pipelines", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/get-started/stages" } }, { - "label": "Metrics, Parameters, and Plots", "slug": "metrics-parameters-plots", + "label": "Metrics, Parameters, and Plots", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/get-started/params-metrics-plots" } @@ -64,8 +59,6 @@ }, { "slug": "experiments", - "label": "Experiments", - "source": "experiments/index.md", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/get-started/experiments" }, @@ -86,9 +79,7 @@ "source": "use-cases/index.md", "children": [ { - "label": "Versioning Data and Models", - "slug": "versioning-data-and-model-files", - "source": "versioning-data-and-model-files/index.md", + "slug": "versioning-data-and-models", "children": [ { "label": "Tutorial 👩‍💻", @@ -97,59 +88,59 @@ ] }, { - "label": "CI/CD for Machine Learning", - "slug": "ci-cd-for-machine-learning" + "slug": "fast-data-caching-hub", + "label": "Fast and Secure Data Caching Hub" }, + "data-registry", { - "label": "Fast and Secure Data Caching Hub", - "slug": "fast-data-caching-hub" + "slug": "ci-cd-for-machine-learning", + "label": "CI/CD for Machine Learning" }, - "experiment-tracking", - "model-registry", - "data-registry" + "ml-experiment-tracking", + "ml-model-registry" ] }, { "slug": "user-guide", - "source": "user-guide/index.md", + "source": false, "children": [ { - "label": "What is DVC?", - "slug": "what-is-dvc" + "slug": "what-is-dvc", + "label": "What is DVC?" }, { "slug": "project-structure", - "source": "project-structure/index.md", "children": [ { - "label": "Pipelines Files (dvc.yaml)", - "slug": "pipelines-files" + "slug": "pipelines-files", + "label": "Pipelines Files (dvc.yaml)" }, { - "label": ".dvc Files", - "slug": "dvc-files" + "slug": "dvc-files", + "label": ".dvc Files" }, { - "label": ".dvcignore Files", "slug": "dvcignore-files", + "label": ".dvcignore Files", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/examples/dvcignore" } }, { - "label": "Internal Files", - "slug": "internal-files" + "slug": "internal-files", + "label": "Internal Directories and Files" } ] }, { - "label": "Experiment Management", "slug": "experiment-management", - "source": "experiment-management/index.md", "children": [ "experiments-overview", "running-experiments", - "comparing-experiments", + { + "slug": "comparing-experiments", + "label": "Reviewing and Comparing" + }, "sharing-experiments", "persisting-experiments", "cleaning-experiments", @@ -162,28 +153,23 @@ "children": [ "stop-tracking-data", "update-tracked-data", - "add-deps-or-outs-to-a-stage", - "merge-conflicts", + "add-stage-deps-or-outs", + "merge-git-conflicts", "share-a-dvc-cache" ] }, "setup-google-drive-remote", "large-dataset-optimization", "external-dependencies", - { - "label": "Managing External Data", - "slug": "managing-external-data" - }, - + "managing-external-data", "running-dvc-on-windows", "troubleshooting", "related-technologies", { - "label": "Anonymized Usage Analytics", - "slug": "analytics" + "slug": "analytics", + "label": "Anonymized Usage Analytics" }, { - "label": "Glossary", "slug": "glossary", "source": "basic-concepts" } @@ -191,294 +177,285 @@ }, { "slug": "command-reference", - "source": "command-reference/index.md", "children": [ { - "label": "add", - "slug": "add" + "slug": "add", + "label": "add" }, { - "label": "cache", "slug": "cache", - "source": "cache/index.md", + "label": "cache", "children": [ { - "label": "cache dir", - "slug": "dir" + "slug": "dir", + "label": "cache dir" } ] }, { - "label": "check-ignore", - "slug": "check-ignore" + "slug": "check-ignore", + "label": "check-ignore" }, { - "label": "checkout", - "slug": "checkout" + "slug": "checkout", + "label": "checkout" }, { - "label": "commit", - "slug": "commit" + "slug": "commit", + "label": "commit" }, { - "label": "config", - "slug": "config" + "slug": "config", + "label": "config" }, { - "label": "dag", - "slug": "dag" + "slug": "dag", + "label": "dag" }, { - "label": "destroy", - "slug": "destroy" + "slug": "destroy", + "label": "destroy" }, { - "label": "diff", - "slug": "diff" + "slug": "diff", + "label": "diff" }, { - "label": "doctor", - "slug": "doctor" + "slug": "doctor", + "label": "doctor" }, { - "label": "exp", "slug": "exp", - "source": "exp/index.md", + "label": "exp", "children": [ { - "label": "exp init", - "slug": "init" + "slug": "init", + "label": "exp init" }, { - "label": "exp run", - "slug": "run" + "slug": "run", + "label": "exp run" }, { - "label": "exp show", - "slug": "show" + "slug": "show", + "label": "exp show" }, { - "label": "exp diff", - "slug": "diff" + "slug": "diff", + "label": "exp diff" }, { - "label": "exp list", - "slug": "list" + "slug": "list", + "label": "exp list" }, { - "label": "exp apply", - "slug": "apply" + "slug": "apply", + "label": "exp apply" }, { - "label": "exp branch", - "slug": "branch" + "slug": "branch", + "label": "exp branch" }, { - "label": "exp remove", - "slug": "remove" + "slug": "remove", + "label": "exp remove" }, { - "label": "exp gc", - "slug": "gc" + "slug": "gc", + "label": "exp gc" }, { - "label": "exp push", - "slug": "push" + "slug": "push", + "label": "exp push" }, { - "label": "exp pull", - "slug": "pull" + "slug": "pull", + "label": "exp pull" } ] }, { - "label": "fetch", "slug": "fetch", + "label": "fetch", "tutorials": { "katacoda": "https://katacoda.com/dvc/courses/examples/fetch" } }, { - "label": "freeze", - "slug": "freeze" + "slug": "freeze", + "label": "freeze" }, { - "label": "gc", - "slug": "gc" + "slug": "gc", + "label": "gc" }, { - "label": "get-url", - "slug": "get-url" + "slug": "get-url", + "label": "get-url" }, { - "label": "get", - "slug": "get" + "slug": "get", + "label": "get" }, { - "label": "import-url", - "slug": "import-url" + "slug": "import-url", + "label": "import-url" }, { - "label": "import", - "slug": "import" + "slug": "import", + "label": "import" }, { - "label": "init", - "slug": "init" + "slug": "init", + "label": "init" }, { - "label": "install", - "slug": "install" + "slug": "install", + "label": "install" }, { - "label": "list", - "slug": "list" + "slug": "list", + "label": "list" }, { - "label": "metrics", "slug": "metrics", - "source": "metrics/index.md", + "label": "metrics", "children": [ { - "label": "metrics show", - "slug": "show" + "slug": "show", + "label": "metrics show" }, { - "label": "metrics diff", - "slug": "diff" + "slug": "diff", + "label": "metrics diff" } ] }, { - "label": "move", - "slug": "move" + "slug": "move", + "label": "move" }, { - "label": "params", "slug": "params", - "source": "params/index.md", + "label": "params", "children": [ { - "label": "params diff", - "slug": "diff" + "slug": "diff", + "label": "params diff" } ] }, { - "label": "plots", "slug": "plots", - "source": "plots/index.md", + "label": "plots", "children": [ { - "label": "plots show", - "slug": "show" + "slug": "show", + "label": "plots show" }, { - "label": "plots diff", - "slug": "diff" + "slug": "diff", + "label": "plots diff" }, { - "label": "plots modify", - "slug": "modify" + "slug": "modify", + "label": "plots modify" } ] }, { - "label": "pull", - "slug": "pull" + "slug": "pull", + "label": "pull" }, { - "label": "push", - "slug": "push" + "slug": "push", + "label": "push" }, { - "label": "remote", "slug": "remote", - "source": "remote/index.md", + "label": "remote", "children": [ { - "label": "remote add", - "slug": "add" + "slug": "add", + "label": "remote add" }, { - "label": "remote modify", - "slug": "modify" + "slug": "modify", + "label": "remote modify" }, { - "label": "remote default", - "slug": "default" + "slug": "default", + "label": "remote default" }, { - "label": "remote list", - "slug": "list" + "slug": "list", + "label": "remote list" }, { - "label": "remote remove", - "slug": "remove" + "slug": "remove", + "label": "remote remove" }, { - "label": "remote rename", - "slug": "rename" + "slug": "rename", + "label": "remote rename" } ] }, { - "label": "remove", - "slug": "remove" + "slug": "remove", + "label": "remove" }, { - "label": "repro", - "slug": "repro" + "slug": "repro", + "label": "repro" }, { - "label": "root", - "slug": "root" + "slug": "root", + "label": "root" }, { - "label": "run", - "slug": "run" + "slug": "run", + "label": "run" }, { - "label": "stage", "slug": "stage", - "source": "stage/index.md", + "label": "stage", "children": [ { - "label": "stage add", - "slug": "add" + "slug": "add", + "label": "stage add" }, { - "label": "stage list", - "slug": "list" + "slug": "list", + "label": "stage list" } ] }, { - "label": "status", - "slug": "status" + "slug": "status", + "label": "status" }, { - "label": "unfreeze", - "slug": "unfreeze" + "slug": "unfreeze", + "label": "unfreeze" }, { - "label": "unprotect", - "slug": "unprotect" + "slug": "unprotect", + "label": "unprotect" }, { - "label": "update", - "slug": "update" + "slug": "update", + "label": "update" }, { - "label": "version", - "slug": "version" + "slug": "version", + "label": "version" } ] }, { "slug": "api-reference", "label": "Python API Reference", - "source": "api-reference/index.md", "children": [ { "slug": "get_url", @@ -499,21 +476,20 @@ ] }, { - "label": "Contributing", "slug": "contributing", "source": false, "children": [ { - "label": "DVC Core Project", - "slug": "core" + "slug": "core", + "label": "DVC Core Project" }, { - "label": "Docs and Website", - "slug": "docs" + "slug": "docs", + "label": "Documentation" }, { - "label": "Writing Blog Posts", - "slug": "blog" + "slug": "blog", + "label": "Writing Blog Posts" } ] }, @@ -523,75 +499,49 @@ "type": "external" }, { - "label": "CML", "slug": "cml", - "source": "cml/index.md", "icon": "cml", - "children": [ - { - "label": "Get Started (GitHub)", - "slug": "start-github" - }, - { - "label": "Get Started (GitLab)", - "slug": "start-gitlab" - }, - "usage", - { - "label": "CML with DVC", - "slug": "cml-with-dvc" - }, - { - "label": "Self-hosted Runners", - "slug": "self-hosted-runners" - }, - { - "label": "Install as a Package", - "slug": "cml-with-npm" - } - ] + "url": "https://cml.dev/doc", + "type": "external" }, { - "label": "Studio", "slug": "studio", - "source": "studio/index.md", "icon": "studio", "children": [ { - "label": "How It Works", - "slug": "overview" + "slug": "how-it-works", + "label": "How It Works" }, "get-started", { - "label": "User Guide", "slug": "user-guide", - "source": "user-guide/index.md", + "source": false, "children": [ { - "label": "Prepare Your Repositories", - "slug": "prepare-repositories" + "slug": "prepare-repositories", + "label": "Prepare Your Repositories" }, { - "label": "Views and Experiments", "slug": "views", + "label": "Views and Experiments", "source": false, "children": [ "what-is-a-view", - "create-view", + "create-a-view", { - "label": "Configure View", - "slug": "view-settings" + "slug": "view-settings", + "label": "Configure a View" }, { - "label": "Explore ML Experiments", - "slug": "explore-experiments" + "slug": "explore-experiments", + "label": "Explore ML Experiments" }, { - "label": "Visualize and Compare", - "slug": "visualize-experiments" + "slug": "visualize-experiments", + "label": "Visualize and Compare" }, "run-experiments", - "share-view" + "share-a-view" ] }, "teams", @@ -606,38 +556,27 @@ ] }, { - "label": "DVCLive", "slug": "dvclive", - "source": "dvclive/index.md", + "label": "DVCLive", "children": [ { - "label": "Get Started", - "slug": "get-started" + "slug": "get-started", + "label": "Get Started" }, { - "label": "DVCLive with DVC", - "slug": "dvclive-with-dvc" + "slug": "dvclive-with-dvc", + "label": "DVCLive with DVC" }, { "slug": "ml-frameworks", - "source": "dvclive/ml-frameworks/index.md", "children": [ - { - "slug": "catalyst", - "label": "Catalyst" - }, + "catalyst", { "slug": "fastai", "label": "Fast.ai" }, - { - "slug": "huggingface", - "label": "Hugging Face" - }, - { - "slug": "keras", - "label": "Keras" - }, + "hugging-face", + "keras", { "slug": "lightgbm", "label": "LightGBM" @@ -666,12 +605,10 @@ }, { "slug": "api-reference", - "source": "api-reference/index.md", "children": [ { "slug": "live", "label": "Live()", - "source": "api-reference/live/index.md", "children": [ { "slug": "log", diff --git a/content/docs/start/data-management/access.md b/content/docs/start/data-management/access.md index 9a0898b4b1..5d88799dd0 100644 --- a/content/docs/start/data-management/access.md +++ b/content/docs/start/data-management/access.md @@ -1,7 +1,3 @@ ---- -title: 'Get Started: Data and Model Access' ---- - # Get Started: Data and Model Access We've learned how to _track_ data and models with DVC, and how to commit their diff --git a/content/docs/start/data-management/index.md b/content/docs/start/data-management/index.md index 2a549d1b46..a4d8669f77 100644 --- a/content/docs/start/data-management/index.md +++ b/content/docs/start/data-management/index.md @@ -1,11 +1,11 @@ --- -title: 'Get Started: Data and Model Versioning' +title: 'Get Started: Data Management' description: 'Get started with data and model versioning in DVC. Learn how to use a regular Git workflow for datasets and ML models, without storing large files in Git.' --- -# Get Started: Data Versioning +# Get Started: Data Management How cool would it be to make Git handle arbitrarily large files and directories with the same performance it has with small code files? Imagine doing a diff --git a/content/docs/start/data-management/metrics-parameters-plots.md b/content/docs/start/data-management/metrics-parameters-plots.md index 151a09f84c..227cd07003 100644 --- a/content/docs/start/data-management/metrics-parameters-plots.md +++ b/content/docs/start/data-management/metrics-parameters-plots.md @@ -1,7 +1,3 @@ ---- -title: 'Get Started: Metrics, Parameters, and Plots' ---- - # Get Started: Metrics, Parameters, and Plots DVC makes it easy to track [metrics](/doc/command-reference/metrics), update diff --git a/content/docs/start/experiments/index.md b/content/docs/start/experiments/index.md index 040d008929..54e358abe9 100644 --- a/content/docs/start/experiments/index.md +++ b/content/docs/start/experiments/index.md @@ -1,7 +1,3 @@ ---- -title: 'Get Started: Experiments' ---- - # Get Started: Experiments In machine learning projects, the number of experiments grows diff --git a/content/docs/start/experiments/visualization.md b/content/docs/start/experiments/visualization.md index d3d8d52764..91e71e19de 100644 --- a/content/docs/start/experiments/visualization.md +++ b/content/docs/start/experiments/visualization.md @@ -1,7 +1,3 @@ ---- -title: 'Get Started: Visualization with Plots' ---- - # Get Started: Visualization with Plots In this section, we'll add visualization to the [`example-dvc-experiments`][ede] diff --git a/content/docs/studio/overview.md b/content/docs/studio/how-it-works.md similarity index 100% rename from content/docs/studio/overview.md rename to content/docs/studio/how-it-works.md diff --git a/content/docs/studio/user-guide/index.md b/content/docs/studio/user-guide/index.md deleted file mode 100644 index 481b7175c2..0000000000 --- a/content/docs/studio/user-guide/index.md +++ /dev/null @@ -1,19 +0,0 @@ -# User Guide - -In this user guide, you will find step by step instructions for all the things -that you can do with Iterative Studio. - -The topics here range from the basic (how to connect to your Git repositories) -to more advanced things you can do such as running experiments. - -We also include guides for getting your Git repositories ready for using with -Iterative Studio, with or without DVC. This includes guides on how to prepare -your repositories, how to install and authorize the Iterative Studio GitHub app, -how to connect to repositories on self-hosted GitLab servers, etc. - -We also include instructions on how to create teams for collaboration in -Iterative Studio, and how to -[upgrade your teams to the **Team** and **Enterprise** plans](/doc/studio/user-guide/change-team-plan-and-size). - -Please choose from the navigation sidebar to the left, or click the `Next` -button below ↘ diff --git a/content/docs/studio/user-guide/install-github-app.md b/content/docs/studio/user-guide/install-github-app.md index de79ce739b..a15ef926f0 100644 --- a/content/docs/studio/user-guide/install-github-app.md +++ b/content/docs/studio/user-guide/install-github-app.md @@ -1,11 +1,11 @@ -# Iterative Studio GitHub App Installation - -If you are using a GitHub account, you will have to install the Iterative Studio -GitHub app on the GitHub repositories/organizations that you want to use with -Iterative Studio. When you try to create a view, if the app is not already -installed, Iterative Studio will not be able to fetch the list of your GitHub -repositories. In this case, you will be prompted to configure Git integrations -as shown below. +# Iterative Studio GitHub App + +If you are using a GitHub account, you can install the Iterative Studio App on +the repositories or organizations that you want to use it with. + +When you try to create a view, if the app is not already installed, Iterative +Studio will not be able to fetch the list of your GitHub repositories. In this +case, you will be prompted to configure Git integrations as shown below. ![](https://static.iterative.ai/img/studio/configure_git_integrations.png) diff --git a/content/docs/studio/user-guide/views/create-view.md b/content/docs/studio/user-guide/views/create-a-view.md similarity index 100% rename from content/docs/studio/user-guide/views/create-view.md rename to content/docs/studio/user-guide/views/create-a-view.md diff --git a/content/docs/studio/user-guide/views/share-view.md b/content/docs/studio/user-guide/views/share-a-view.md similarity index 100% rename from content/docs/studio/user-guide/views/share-view.md rename to content/docs/studio/user-guide/views/share-a-view.md diff --git a/content/docs/use-cases/experiment-tracking.md b/content/docs/use-cases/ml-experiment-tracking.md similarity index 100% rename from content/docs/use-cases/experiment-tracking.md rename to content/docs/use-cases/ml-experiment-tracking.md diff --git a/content/docs/use-cases/model-registry.md b/content/docs/use-cases/ml-model-registry.md similarity index 89% rename from content/docs/use-cases/model-registry.md rename to content/docs/use-cases/ml-model-registry.md index fc3396fbfa..fa0f786b3b 100644 --- a/content/docs/use-cases/model-registry.md +++ b/content/docs/use-cases/ml-model-registry.md @@ -52,10 +52,10 @@ distribute them. It can store model files on the cloud (by itself or with DVC), list and transfer them within locations, wrap them as a local REST server, or even containerize and deploy them to cloud providers! -This ecosystem of tools from [Iterative](https://iterative.ai/) brings your ML -process into [GitOps]. This means you can manage and deliver ML models with -software engineering methods such as continuous integration (CI/CD), which can -sync with the state of the artifacts in your registry. +This ecosystem of tools [from Iterative](https://iterative.ai/model-registry) +brings your ML process into [GitOps]. This means you can manage and deliver ML +models with software engineering methods such as continuous integration (CI/CD), +which can sync with the state of the artifacts in your registry. [modeling process]: /doc/start/data-pipelines [remote storage]: /doc/command-reference/remote diff --git a/content/docs/use-cases/versioning-data-and-model-files/index.md b/content/docs/use-cases/versioning-data-and-models/index.md similarity index 100% rename from content/docs/use-cases/versioning-data-and-model-files/index.md rename to content/docs/use-cases/versioning-data-and-models/index.md diff --git a/content/docs/use-cases/versioning-data-and-model-files/tutorial.md b/content/docs/use-cases/versioning-data-and-models/tutorial.md similarity index 100% rename from content/docs/use-cases/versioning-data-and-model-files/tutorial.md rename to content/docs/use-cases/versioning-data-and-models/tutorial.md diff --git a/content/docs/user-guide/experiment-management/cleaning-experiments.md b/content/docs/user-guide/experiment-management/cleaning-experiments.md index e220cbc7a5..ca2ca974cf 100644 --- a/content/docs/user-guide/experiment-management/cleaning-experiments.md +++ b/content/docs/user-guide/experiment-management/cleaning-experiments.md @@ -1,4 +1,4 @@ -# Cleaning Up Experiments +# Cleaning Experiments Although DVC uses minimal resources to keep track of the experiments, they may clutter tables and the workspace. DVC allows to remove specific experiments from diff --git a/content/docs/user-guide/how-to/add-deps-or-outs-to-a-stage.md b/content/docs/user-guide/how-to/add-stage-deps-or-outs.md similarity index 94% rename from content/docs/user-guide/how-to/add-deps-or-outs-to-a-stage.md rename to content/docs/user-guide/how-to/add-stage-deps-or-outs.md index 950118bd2b..e672c852dc 100644 --- a/content/docs/user-guide/how-to/add-deps-or-outs-to-a-stage.md +++ b/content/docs/user-guide/how-to/add-stage-deps-or-outs.md @@ -1,10 +1,10 @@ --- -title: 'How to Add Dependencies or Outputs to a Stage' +title: 'How to Add Stage Dependencies or Outputs' description: "It's possible to add files or directories to existing stages, with or without executing them." --- -# How to Add Dependencies or Outputs +# How to Add Stage Dependencies or Outputs To add dependencies or outputs to a [stage](/doc/command-reference/run), edit the `dvc.yaml` file (by hand or using diff --git a/content/docs/user-guide/how-to/merge-conflicts.md b/content/docs/user-guide/how-to/merge-git-conflicts.md similarity index 97% rename from content/docs/user-guide/how-to/merge-conflicts.md rename to content/docs/user-guide/how-to/merge-git-conflicts.md index a7cb7034ab..2aff3e75f3 100644 --- a/content/docs/user-guide/how-to/merge-conflicts.md +++ b/content/docs/user-guide/how-to/merge-git-conflicts.md @@ -1,10 +1,10 @@ --- -title: 'How to Merge Conflicts' +title: 'How to Merge Git Conflicts in DVC Metafiles' description: 'Git merge conflicts can happen in DVC files when combining changes from multiple team members.' --- -# How to Merge Conflicts in DVC Files +# How to Merge Git Conflicts in DVC Metafiles Sometimes multiple team members work on the the same DVC-tracked data. When the time comes to combine their changes, merge conflicts can occur in Git-tracked diff --git a/content/docs/user-guide/index.md b/content/docs/user-guide/index.md deleted file mode 100644 index 008e534b7d..0000000000 --- a/content/docs/user-guide/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# User Guide - -Our guides describe the major concepts in DVC and how it works comprehensively, -explaining when and how to use what, as well as inter-relationship between them. - -The topics here range from more foundational (impacting many parts of DVC) to -more specific and advanced things you can do. We also include a few misc. -guides, for example related to -[contributing to DVC](/doc/user-guide/contributing/core) itself. - -Please choose from the navigation sidebar to the left, or click the `Next` -button below ↘ diff --git a/content/docs/user-guide/project-structure/index.md b/content/docs/user-guide/project-structure/index.md index 0f63051540..aff3afbabc 100644 --- a/content/docs/user-guide/project-structure/index.md +++ b/content/docs/user-guide/project-structure/index.md @@ -1,4 +1,4 @@ -# Project Structure +# DVC Project Structure Using `dvc init` in your workspace will start a DVC project, including the internal `.dvc/` directory. From there on, you diff --git a/content/docs/user-guide/related-technologies.md b/content/docs/user-guide/related-technologies.md index b29c37b0a0..e893d4a398 100644 --- a/content/docs/user-guide/related-technologies.md +++ b/content/docs/user-guide/related-technologies.md @@ -1,4 +1,4 @@ -# Comparison with Related Technologies +# Related Technologies (Comparisons) DVC combines a number of existing ideas into a single tool, with the goal of bringing best practices from software engineering into the data science field diff --git a/content/docs/user-guide/setup-google-drive-remote.md b/content/docs/user-guide/setup-google-drive-remote.md index 70504fcf1d..85c24167a8 100644 --- a/content/docs/user-guide/setup-google-drive-remote.md +++ b/content/docs/user-guide/setup-google-drive-remote.md @@ -1,6 +1,6 @@ -# Setup a Google Drive DVC Remote +# Setup Google Drive as DVC Remote Storage -In this guide we explain the existing ways to setup Google Drive +In this guide we explain the existing ways to setup Google Drive as [remote storage](/doc/command-reference/remote) for your DVC projects, along with the different benefits each one brings. diff --git a/redirects-list.json b/redirects-list.json index f24e5088c3..9383c8d2bd 100644 --- a/redirects-list.json +++ b/redirects-list.json @@ -50,10 +50,14 @@ "^/doc/use-cases/data-and-model-files-versioning/?$ /doc/use-cases/versioning-data-and-model-files", "^/doc/use-cases/shared-development-server$ /doc/use-cases/fast-data-storage-layer#example-shared-development-server", "^/doc/use-cases/data-registries$ /doc/use-cases/data-registry", + "^/doc/use-cases/experiment-tracking$ /doc/use-cases/ml-experiment-tracking", + "^/doc/use-cases/model-registry$ /doc/use-cases/ml-model-registry 302", "^/doc/user-guide/updating-tracked-files$ /doc/user-guide/how-to/update-tracked-data", "^/doc/user-guide/how-to/update-tracked-files$ /doc/user-guide/how-to/update-tracked-data", "^/doc/user-guide/merge-conflicts$ /doc/user-guide/how-to/merge-conflicts", + "^/doc/user-guide/how-to/add-deps-or-outs-to-a-stage$ /doc/user-guide/how-to/add-stage-deps-or-outs", + "^/doc/user-guide/how-to/merge-conflicts$ /doc/user-guide/how-to/merge-git-conflicts", "^/doc/user-guide/dvc-file-format$ /doc/user-guide/project-structure", "^/doc/user-guide/dvc-files$ /doc/user-guide/project-structure", "^/doc/user-guide/dvc-files/dvc-yaml$ /doc/user-guide/project-structure",