Skip to content

Commit

Permalink
Merge pull request #935 from iterative/snap
Browse files Browse the repository at this point in the history
install: add snap instructions
  • Loading branch information
jorgeorpinel committed Jan 22, 2020
2 parents a4fa6bb + c4684f9 commit 2e33e98
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
5 changes: 3 additions & 2 deletions public/static/docs/install/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ Enjoy working with DVC faster and with fewer typos!

Shell completion is automatically enabled when DVC is installed on MacOS
[with Homebrew](/doc/install/macos#install-with-brew), or on Linux
[from **deb** or **rpm** repository](/doc/install/linux#install-from-repository).
Please follow the instructions below for other DVC installation methods.
[from **deb** or **rpm** repositories](/doc/install/linux#install-from-repository)
or via [**snap**](/doc/install/linux#install-with-snap). Please follow the
instructions below for other DVC installation methods.

## How it works

Expand Down
15 changes: 15 additions & 0 deletions public/static/docs/install/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,21 @@ $ conda install -c conda-forge dvc

> Currently, it supports only Python versions 2.7, 3.6, and 3.7.
## Install with snap

> Requires [snapd](https://snapcraft.io/docs/installing-snapd).
To install the latest stable version of `dvc`:

```dvc
$ snap install --classic dvc
```

Add `--edge` to install the latest beta (master) version.

> 💡 When connected to the internet, `snap` will automatically look for updates
> every 6 hours.
## Install from repository

<details>
Expand Down
12 changes: 6 additions & 6 deletions public/static/docs/user-guide/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ website.

## Structure of the project

To contribute documentation you need to know these locations:
To contribute documentation, these are the relevant locations under
`public/static/`:

- [Content](https://github.com/iterative/dvc.org/tree/master/public/static/docs)
(`/docs`): [Markdown](https://guides.github.com/features/mastering-markdown/)
(`docs/`): [Markdown](https://guides.github.com/features/mastering-markdown/)
files of the different pages to render dynamically in the browser.
- [Images](https://github.com/iterative/dvc.org/tree/master/public/static/img)
(`/static/img`): Add new images, gif, svg, etc here. Reference them from the
Markdown files like this: `![](/static/img/reproducibility.png)`.
(`img/`): Add new images (png, svg, etc.) here. Reference them from the Markdown
files like this: `![](/static/img/reproducibility.png)`.
- [Sections](https://github.com/iterative/dvc.org/tree/master/public/static/docs/sidebar.json)
(`.../sidebar.json`): Edit it to register a new section for the navigation
menu.
(`docs/sidebar.json`): Edit it to register a new section for the navigation menu.

Merging the appropriate changes to these files into the master branch is enough
to update the docs and redeploy the website.
Expand Down

0 comments on commit 2e33e98

Please sign in to comment.