Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nav: updates #3599

Closed
wants to merge 14 commits into from
2 changes: 1 addition & 1 deletion content/docs/dvclive/api-reference/live/set_step.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# dvclive.set_step()
# Live.set_step()

Signals that the current step has ended and sets step to the given value.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/install/completion.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Shell Tab Completion
# Shell Completion

Enjoy working with DVC faster and with fewer typos!

Expand Down
2 changes: 1 addition & 1 deletion content/docs/install/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
12 changes: 6 additions & 6 deletions content/docs/install/linux.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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/).
Expand All @@ -66,7 +66,7 @@ In this case it installs the `boto3` library along with DVC.

</details>

## Install with snap
## With Snapcraft

> Requires [snapd](https://snapcraft.io/docs/installing-snapd).

Expand All @@ -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

<details id="from-repo-on-debian-ubuntu">

Expand Down Expand Up @@ -109,7 +109,7 @@ $ sudo yum install dvc

</details>

## 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.
Expand Down
10 changes: 5 additions & 5 deletions content/docs/install/macos.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# 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/).

```dvc
$ 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.
Expand All @@ -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)
Expand Down Expand Up @@ -55,7 +55,7 @@ In this case it installs the `boto3` library along with DVC.

</details>

## Install with conda
## With Conda

> Requires [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or
> [Anaconda Distribution](https://docs.anaconda.com/anaconda/).
Expand Down
2 changes: 1 addition & 1 deletion content/docs/install/plugins.md
Original file line number Diff line number Diff line change
@@ -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,
<abbr>DVC files</abbr> are created or updated. These use a simple YAML format.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/install/pre-release.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
10 changes: 5 additions & 5 deletions content/docs/install/windows.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -7,17 +7,17 @@
> 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:

```dvc
$ 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/).
Expand Down Expand Up @@ -48,7 +48,7 @@ In this case it installs the `boto3` library along with DVC.

</details>

## Install with pip
## With Pip

From Command Prompt or other
[recommended consoles](/doc/user-guide/running-dvc-on-windows):
Expand Down
Loading