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

Regular updates (Apr 27) #1195

Merged
merged 11 commits into from
May 7, 2020
8 changes: 6 additions & 2 deletions content/blog/2020-04-30-gsod-ideas-2020.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,11 @@ technical writer, [Jorge](https://github.com/jorgeorpinel).
[release history](https://github.com/iterative/dvc/releases) are not
completely backward-compatible. We expect that fully updating all our
previous docs will take a few months, and you could help us with this! The
main new features are:
main new features are listed below.

> UPDATE: See [post](https://dvc.org/blog/dvc-3-years-and-1-0-release) about
> the release! And corresponding docs
> [epic](https://github.com/iterative/dvc.org/issues/1255) task

- A
[multi-stage _pipelines file_](https://github.com/iterative/dvc/issues/1871)
Expand Down Expand Up @@ -226,7 +230,7 @@ technical writer, [Jorge](https://github.com/jorgeorpinel).
[blog-engine](https://github.com/iterative/dvc.org/issues?q=is%3Aopen+is%3Aissue+label%3Ablog-engine)
issues

_Difficulty rating:_ Advanced<br/><br/>
_Difficulty rating:_ Medium-Advanced<br/><br/>

> For more inspiration, feel free to review our
> [epics](https://github.com/iterative/dvc.org/labels/epic) and other open docs
Expand Down
4 changes: 2 additions & 2 deletions content/blog/2020-05-04-dvc-3-years-and-1-0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ All these contributions, big and small, have a collective impact on DVC's
development. I'm happy (and a bit nervous) to announce that a pre-release of a
brand new DVC 1.0 is ready for public beta testing.

You can install the pre-release version from the development branch (instruction
on [our website](https://dvc.org/doc/install/pre-release)) or through pip:
You can install the 1.0 pre-release from the master branch in our repo
(instruction [here](https://dvc.org/doc/install/pre-release)) or through pip:

```dvc
$ pip install --upgrade --pre dvc
Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,15 +160,16 @@ For more information about the variables DVC supports, please visit

```dvc
$ dvc remote add --local myremote azure://my-container-name/path
$ dvc remote modify --local myremote connection_string "my-connection-string"
$ dvc remote modify --local myremote connection_string \
"my-connection-string"
```

> The connection string contains access to data and is inserted into the
> `.dvc/config` file. Therefore, it is safer to add the connection string with
> the `--local` option, enforcing it to be written to a Git-ignored config file.
> See `dvc remote modify` for a full list of Azure storage parameters.
> `.dvc/config` file. Therefore, it is safer to add the remote with the
> `--local` option, enforcing it to be written to a Git-ignored config file. See
> `dvc remote modify` for a full list of Azure storage parameters.

The Azure Blob Storage remote can also be configured entirely via environment
The Azure Blob Storage remote can also be configured globally via environment
variables:

```dvc
Expand Down
10 changes: 5 additions & 5 deletions content/docs/install/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installation

Please double check that you don't already have DVC (for example running
`which dvc`) before trying to install it (again).
> Please double check that you don't already have DVC (for example running
> `which dvc`) before trying to install it.

- [Install on MacOS](/doc/install/macos)
- [Install on Windows](/doc/install/windows)
Expand All @@ -16,12 +16,12 @@ if needed. The [Python API](/doc/api-reference) module is `dvc.api`.

## Advanced options

- You can [install a stable pre-release](/doc/install/pre-release) of DVC to
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
stay ahead of official releases.

- Shell completion is automatically enabled by certain installation methods. If
it does not work for you, please see
[these instructions](/doc/install/completion) to set it up.

- You can [install a stable pre-release](/doc/install/pre-release) of DVC to
stay ahead of official releases.

- Please also check out these 3rd-party tool [plugins](/doc/install/plugins),
which might be useful.
3 changes: 1 addition & 2 deletions content/docs/install/pre-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,5 @@ $ pip install git+https://github.com/iterative/dvc
> information on our versioning convention, refer to
> [Components of DVC version](/doc/command-reference/version#components-of-dvc-version).

To install a development version for contributing to the project, please refer
to
To install a development version, for contributing to the project, please see
[Development environment](/doc/user-guide/contributing/core#development-environment).
26 changes: 19 additions & 7 deletions content/docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
> To use DVC [as a Python library](/doc/api-reference), please
> [install with pip](#install-with-pip) or [with conda](#install-with-conda).

## Windows installer
## Install with choco

The easiest way is to use the self-contained, executable installer (binary),
which is available from the big "Download" button on the [home page](/). You can
also get it from the [release page](https://github.com/iterative/dvc/releases/)
on GitHub.
The easiest way to install from command line for most cases is to install
[Chocolatey](https://chocolatey.org/) on your machine, and use the `choco`
command:

> You may use Windows Uninstaller to
> [remove the program](https://support.microsoft.com/en-us/help/4028054/windows-10-repair-or-remove-programs).
```dvc
$ choco install dvc
```

## Install with conda

Expand Down Expand Up @@ -56,3 +56,15 @@ $ pip install "dvc[s3]"
In this case it installs `boto3` library as well, besides DVC.

</details>

## Windows installer

An easy way is to use the self-contained, executable installer (binary), which
is available from the big "Download" button on the [home page](/). You can also
get it from the [release page](https://github.com/iterative/dvc/releases/) on
GitHub.

> You'll need to download the installer each time to update DVC.

> You may use Windows Uninstaller to
> [remove the program](https://support.microsoft.com/en-us/help/4028054/windows-10-repair-or-remove-programs).
19 changes: 4 additions & 15 deletions content/docs/user-guide/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,11 @@ We will review your PR as soon as possible. Thank you for contributing!

## Development environment

We highly recommend running this web app to check documentation or blog changes
before submitting them, and it's quite necessary when making changes to the
website engine itself. Source code and content files need to be properly
We highly recommend running this web app locally to check documentation or blog
changes before submitting them, and it's quite necessary when making changes to
the website engine itself. Source code and content files need to be properly
formatted and linted as well, which is also ensured by the full setup below.

> ⚡ You can contribute online, using Gitpod (a fully featured online
> development environment), it'll automatically clone the repo, install the
> dependencies, run `yarn build`, and start the webserver so that you can start
> straight away:
>
> <a href="https://gitpod.io/#https://github.com/iterative/dvc.org">
> <img src="https://gitpod.io/button/open-in-gitpod.svg" alt="Open in Gitpod">
> </a>

Make sure you have a recent LTS version of [Node.js](https://nodejs.org/en/)
(`>=12.0.0`), and install [Yarn](https://yarnpkg.com/):

Expand Down Expand Up @@ -158,9 +149,7 @@ pre-commit hook that is integrated when `yarn` installs the project dependencies
- We use [Prettier](https://prettier.io/) to format our source code (see
[its configuration](https://github.com/iterative/dvc.org/blob/master/.prettierrc)).
The formatting of staged files will automatically be done by a Git pre-commit
hook. You may also run `yarn format <file>` (format specific file/pattern),
`yarn format-staged` (all staged files), or `yarn format-all` (all `.md`,
`.js` and other source files) before committing changes if needed.
hook. You may also run the formatting [commands](#all-commands) manually.
([Advanced usage](https://prettier.io/docs/en/cli.html) of Prettier is
available through `yarn prettier ...`)

Expand Down