Skip to content

Commit

Permalink
guide: nav follow-ups (#4015)
Browse files Browse the repository at this point in the history
* guide: reorg sidebar

* guide: update sidebar plus redirects

* Update redirects-list.json

* guide: minor fixes to sidebar edits

* plots: more links for pcp
rel #4011 (review)

* fix admon typoe

* guide: update links (#4017)

* guide: update links based on
https://github.com/iterative/dvc.org/pull/4011/files#diff-a6828b19e9794c1fbb6799ea95263fb7487b676d054932b5f6e3b315eb12a6a2

* start: remove Data Mgmt index page (#4016)

* start: remove Data Mgmt index pg and
move some of its contents to the GS index page

* Update content/docs/start/index.md

* dvc 2.29.0 (#4021)

Co-authored-by: efiop <[email protected]>

* how-to: fix run-dvc-on-win links

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: efiop <[email protected]>

* Update src/components/DownloadButton/index.tsx

Co-authored-by: dberenbaum <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: efiop <[email protected]>
  • Loading branch information
4 people authored Oct 14, 2022
1 parent 8612f24 commit 13fc91e
Show file tree
Hide file tree
Showing 45 changed files with 184 additions and 151 deletions.
8 changes: 4 additions & 4 deletions content/docs/command-reference/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ You can also [undo `dvc add`](/doc/user-guide/how-to/stop-tracking-data) to stop
tracking files or directories.

By default, DVC tries to use reflinks (see
[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)
[File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache)
to avoid copying any file contents and to optimize `.dvc` file operations for
large files. DVC also supports other link types for use on file systems without
`reflink` support, but they have to be specified manually. Refer to the
Expand Down Expand Up @@ -149,7 +149,7 @@ not.

- `--external` - allow tracking `targets` outside of the DVC repository
in-place. See
[Managing External Data](/doc/user-guide/managing-external-data).
[Managing External Data](/doc/user-guide/data-management/managing-external-data).

> ⚠️ Note that this is an advanced feature for very specific situations and
> not recommended except if there's absolutely no other alternative.
Expand Down Expand Up @@ -384,9 +384,9 @@ outs:
```

[linked]:
/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache
/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache
[external cache]:
/doc/user-guide/managing-external-data#setting-up-an-external-cache
/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache

## Example: Transfer to remote storage

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/cache/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Tracked files and directories visible in the <abbr>workspace</abbr> are links\*
to the ones in the project's <abbr>cache</abbr>.

> \* Or copies. Refer to
> [File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)
> [File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache)
> for more information on supported linking on different platforms.
For cache configuration options, refer to `dvc config cache`.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ for more details.

By default, this command tries not make copies of cached files in the workspace,
using reflinks instead when supported by the file system (refer to
[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)).
[File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache)).
The next linking strategy default value is `copy` though, so unless other file
link types are manually configured in `cache.type` (using `dvc config`), files
will be copied. Keep in mind that having file copies doesn't present much of a
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ See `dvc remote add` and `dvc remote modify` for more information.
`dvc unprotect` to be able to modify them safely.

There are pros and cons to different link types. Refer to
[File link types](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)
[File link types](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache)
for a full explanation of each one.

To apply changes to this config option in the workspace, restore all file
Expand All @@ -204,7 +204,7 @@ See `dvc remote add` and `dvc remote modify` for more information.
[`os.umask`](https://docs.python.org/3/library/os.html#os.umask).

The following parameters allow setting an
[external cache](/doc/user-guide/managing-external-data#setting-up-an-external-cache)
[external cache](/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache)
location. A [DVC remote](/doc/command-reference/remote) name is used (instead of
the URL) because often it's necessary to configure authentication or other
connection settings, and configuring a remote is the way that can be done.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/dag.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This command's output is automatically piped to
is not available (e.g. on Windows), the output is simply printed out.

> It's also possible to
> [enable `less` on Windows](/doc/user-guide/running-dvc-on-windows#enabling-paging-with-less).
> [enable `less` on Windows](/doc/user-guide/how-to/run-dvc-on-windows#enabling-paging-with-less).
> Note that this also applies to `dvc exp show`.
Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ directory from the <abbr>project</abbr>.

Note that the <abbr>cache directory</abbr> will be removed as well, unless it's
set to an
[external location](/doc/user-guide/managing-external-data#setting-up-an-external-cache)
[external location](/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache)
(by default a local cache is located in `.dvc/cache`). If you have setup
[symlinks](/doc/user-guide/large-dataset-optimization) (from cache to workspace)
in your project, DVC will replace them with the latest versions of the actual
files and directories first, so that your data is intact after destruction.
[symlinks](/doc/user-guide/data-management/large-dataset-optimization) (from
cache to workspace) in your project, DVC will replace them with the latest
versions of the actual files and directories first, so that your data is intact
after destruction.

[external cache]:
/doc/user-guide/managing-external-data#setting-up-an-external-cache
/doc/user-guide/data-management/managing-external-data#setting-up-an-external-cache

> Refer to [Project Structure](/doc/user-guide/project-structure) for more
> details on the directories and files deleted by this command.
Expand Down
12 changes: 7 additions & 5 deletions content/docs/command-reference/exp/show.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# exp show

Displays your experiments in a customizable table or
[parallel coordinates plot](/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot).
Displays your experiments in a customizable table or [parallel coordinates
plot].

> Press `q` to exit.
[parallel coordinates plot]:
/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot

## Synopsis

```usage
Expand Down Expand Up @@ -58,8 +61,7 @@ sorted inside each group, chronologically by default. The `--sort-by` and
`--sort-order` options can change this ordering, based on any single, visible
metric or param.

When the `--pcp` option is passed, an interactive
[parallel coordinates plot](/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot)
When the `--pcp` option is passed, an interactive [parallel coordinates plot]
will be generated using the same data from the table.

![](/img/pcp_interaction.gif) _Parallel Coordinates Plot_
Expand All @@ -72,7 +74,7 @@ This command's output is automatically piped to
is not available (e.g. on Windows), the output is simply printed out.

> It's also possible to
> [enable `less` on Windows](/doc/user-guide/running-dvc-on-windows#enabling-paging-with-less).
> [enable `less` on Windows](/doc/user-guide/how-to/run-dvc-on-windows#enabling-paging-with-less).
### Providing a custom pager

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ Here are some scenarios in which `dvc fetch` is useful, instead of pulling:
DVC-tracked data from multiple project branches or tags into your machine.
- To use comparison commands across different Git commits, for example
`dvc metrics show` with its `--all-branches` option, or `dvc plots diff`.
- If you want to avoid [linking](/doc/user-guide/large-dataset-optimization)
files from the cache, or keep the <abbr>workspace</abbr> clean for any other
reason.
- If you want to avoid
[linking](/doc/user-guide/data-management/large-dataset-optimization) files
from the cache, or keep the <abbr>workspace</abbr> clean for any other reason.

Without arguments, it downloads all files and directories referenced in the
current workspace (found in `dvc.yaml` and `.dvc` files) that are missing from
Expand Down
14 changes: 7 additions & 7 deletions content/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ update the import later, if the data source has changed (see `dvc update`).
> `dvc import`).
`.dvc` files support references to data in an external location, see
[External Dependencies](/doc/user-guide/external-dependencies). In such an
import `.dvc` file, the `deps` field stores the external URL, and the `outs`
field contains the corresponding local path in the <abbr>workspace</abbr>. It
records enough metadata about the imported data to enable DVC efficiently
determining whether the local copy is out of date.
[External Dependencies](/doc/user-guide/data-management/importing-external-data).
In such an import `.dvc` file, the `deps` field stores the external URL, and the
`outs` field contains the corresponding local path in the
<abbr>workspace</abbr>. It records enough metadata about the imported data to
enable DVC efficiently determining whether the local copy is out of date.

Note that `dvc repro` doesn't check or update import `.dvc` files, use
`dvc update` to bring the import up to date from the data source.
Expand Down Expand Up @@ -113,8 +113,8 @@ generating a pipeline [stage](/doc/command-reference/run) with an external
dependency.

> This is discussed in the
> [External Dependencies](/doc/user-guide/external-dependencies) documentation,
> where an alternative is demonstrated for each of these schemes.
> [External Dependencies](/doc/user-guide/data-management/importing-external-data)
> documentation, where an alternative is demonstrated for each of these schemes.
Instead of:

Expand Down
5 changes: 3 additions & 2 deletions content/docs/command-reference/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,9 @@ $ git archive -o code.zip HEAD
$ dvc list . -R --dvc-only | zip -@ data.zip
```

ZIP alternative for [POSIX on Windows](/doc/user-guide/running-dvc-on-windows)
(Python installed):
ZIP alternative for
[POSIX on Windows](/doc/user-guide/how-to/run-dvc-on-windows) (Python
installed):

```dvc
$ dvc list . -R --dvc-only | xargs python -m zipfile -c data.zip
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/move.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ the <abbr>project</abbr> with `dvc add` or `dvc import`, creating a `.dvc` file
`dvc.yaml`), they have to be [renamed manually](#renaming-stage-outputs).

> Note that `src` itself may be either a
> [link](/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache)
> [link](/doc/user-guide/data-management/large-dataset-optimization#file-link-types-for-the-dvc-cache)
> or a copy to the corresponding data in the cache. The <abbr>cached</abbr> file
> is not changed by this command.
Expand Down
7 changes: 4 additions & 3 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ option. To learn more about plots files and templates please see `dvc plots`.
Another way to display plots is the `dvc plots show` command, which just lists
all the current plots, without comparisons.

[certain metrics]: /doc/user-guide/visualizing-plots#supported-plot-file-formats
[certain metrics]:
/doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats
[plot templates]:
/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only

Expand All @@ -69,7 +70,7 @@ all the current plots, without comparisons.
[`plots.out_dir`](/doc/command-reference/config#plots) config option.

- `-t <name_or_path>, --template <name_or_path>` -
[plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only)
[plot template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only)
to be injected with data. The default template is `.dvc/plots/default.json`.
See more details in `dvc plots`.

Expand Down Expand Up @@ -150,7 +151,7 @@ cat,turtle
```

The predefined confusion matrix
[template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only)
[template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only)
(in `.dvc/plots/confusion.json`) shows how metrics comparisons can be faceted by
separate plots. It can be enabled with `-t` (`--template`):

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/plots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Plots have to be defined either at the stage level, or at the pipeline level in

See [Visualizing Plots] and [Top-level plot definitions] for more details

[visualizing plots]: /doc/user-guide/visualizing-plots
[visualizing plots]: /doc/user-guide/experiment-management/visualizing-plots
[top-level plot definitions]:
/doc/user-guide/project-structure/dvcyaml-files#top-level-plot-definitions

Expand Down
5 changes: 3 additions & 2 deletions content/docs/command-reference/plots/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ defined in <abbr>stages</abbr>.
> ⚠️ Note that this command can modify only data-series plots. It has no effect
> on image-type plots or any [top-level plot] definitions.
[top-level plot]: /doc/user-guide/visualizing-plots#top-level-plots
[top-level plot]:
/doc/user-guide/experiment-management/visualizing-plots#top-level-plots

## Synopsis

Expand Down Expand Up @@ -44,7 +45,7 @@ Note that a secondary use of this command is to convert output or simple
## Options

- `-t <name_or_path>, --template <name_or_path>` - set a default
[plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only).
[plot template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only).

- `-x <field>` - set a default field or column name (or number) from which the X
axis data comes from.
Expand Down
17 changes: 10 additions & 7 deletions content/docs/command-reference/plots/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
Generate [plot](/doc/command-reference/plots) from a plots file or `plots`
[top-level definition] from `dvc.yaml`.

[top-level definition]: /doc/user-guide/visualizing-plots#top-level-plots
[top-level definition]:
/doc/user-guide/experiment-management/visualizing-plots#top-level-plots

## Synopsis

Expand Down Expand Up @@ -38,11 +39,13 @@ The default behavior of this command can be modified per [stage plot] file with

</admon>

[certain data]: /doc/user-guide/visualizing-plots#supported-plot-file-formats
[certain data]:
/doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats
[plot templates]:
/doc/user-guide/visualizing-plots#plot-templates-data-series-only
[top-level plot]: /doc/user-guide/visualizing-plots#top-level-plots
[stage plot]: /doc/user-guide/visualizing-plots
/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only
[top-level plot]:
/doc/user-guide/experiment-management/visualizing-plots#top-level-plots
[stage plot]: /doc/user-guide/experiment-management/visualizing-plots

## Options

Expand All @@ -51,7 +54,7 @@ The default behavior of this command can be modified per [stage plot] file with
[`plots.out_dir`](/doc/command-reference/config#plots) config option.

- `-t <name_or_path>, --template <name_or_path>` -
[plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only)
[plot template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only)
to be injected with data. The default template is `.dvc/plots/default.json`.
See more details in `dvc plots`.

Expand Down Expand Up @@ -480,7 +483,7 @@ file:///Users/usr/src/dvc_plots/index.html
![](/img/plots_show_confusion.svg)

> A confusion matrix
> [template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only)
> [template](/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only)
> is predefined in DVC.

We can use `confusion_normalized` template to normalize the results:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/plots/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ important fields that DVC adds to the plot data:
</details>

[plot templates]:
https://dvc.org/doc/user-guide/visualizing-plots#plot-templates-data-series-only
https://dvc.org/doc/user-guide/experiment-management/visualizing-plots#plot-templates-data-series-only
[vega-lite specification]: https://vega.github.io/vega-lite/
[data-series plots]: /doc/user-guide/visualizing-plots
[data-series plots]: /doc/user-guide/experiment-management/visualizing-plots

## Example: Modifying the `simple` template

Expand Down
8 changes: 4 additions & 4 deletions content/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ To use a custom authentication method, use the parameters described in
### Google Drive

To start using a GDrive remote, first add it with a
[valid URL format](/doc/user-guide/setup-google-drive-remote#url-format). Then
use any DVC command that needs to connect to it (e.g. `dvc pull` or `dvc push`
once there's tracked data to synchronize). For example:
[valid URL format](/doc/user-guide/how-to/setup-google-drive-remote#url-format).
Then use any DVC command that needs to connect to it (e.g. `dvc pull` or
`dvc push` once there's tracked data to synchronize). For example:

```cli
$ dvc remote add -d myremote gdrive://0AIac4JZqHhKmUk9PDA/dvcstore
Expand All @@ -184,7 +184,7 @@ Enter verification code: # <- enter resulting code
```

See `dvc remote modify` for a list of other GDrive parameters, or
[Set up a Google Drive DVC Remote](/doc/user-guide/setup-google-drive-remote)
[Set up a Google Drive DVC Remote](/doc/user-guide/how-to/setup-google-drive-remote)
for a full guide on using Google Drive as DVC remote storage.

Note that GDrive remotes are not "trusted" by default. This means that the
Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -559,19 +559,19 @@ can propagate from an Azure configuration file (typically managed with
> file.
Please see
[Set up a Google Drive DVC Remote](/doc/user-guide/setup-google-drive-remote)
[Set up a Google Drive DVC Remote](/doc/user-guide/how-to/setup-google-drive-remote)
for a full guide on using Google Drive as DVC remote storage.

- `url` - remote location. See
[valid URL format](/doc/user-guide/setup-google-drive-remote#url-format).
[valid URL format](/doc/user-guide/how-to/setup-google-drive-remote#url-format).

```dvc
$ dvc remote modify myremote url \
gdrive://0AIac4JZqHhKmUk9PDA/dvcstore
```

- `gdrive_client_id` - Client ID for authentication with OAuth 2.0 when using a
[custom Google Client project](/doc/user-guide/setup-google-drive-remote#using-a-custom-google-cloud-project-recommended).
[custom Google Client project](/doc/user-guide/how-to/setup-google-drive-remote#using-a-custom-google-cloud-project-recommended).
Also requires using `gdrive_client_secret`.

```dvc
Expand Down Expand Up @@ -607,8 +607,9 @@ for a full guide on using Google Drive as DVC remote storage.
gdrive_user_credentials_file path/to/mycredentials.json
```

See [Authorization](/doc/user-guide/setup-google-drive-remote#authorization) for
more details.
See
[Authorization](/doc/user-guide/how-to/setup-google-drive-remote#authorization)
for more details.

- `gdrive_trash_only` - configures `dvc gc` to move remote files to
[trash](https://developers.google.com/drive/api/v2/reference/files/trash)
Expand Down
Loading

0 comments on commit 13fc91e

Please sign in to comment.