From 6078dc89179d20f6e1f20aaa800685b43f50d7f1 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Sun, 19 Jan 2020 20:01:23 +0000 Subject: [PATCH 1/4] add snap install instructions - fixes #918 --- public/static/docs/install/completion.md | 5 +++-- public/static/docs/install/linux.md | 15 +++++++++++++++ .../static/docs/user-guide/contributing/docs.md | 12 ++++++------ 3 files changed, 24 insertions(+), 8 deletions(-) diff --git a/public/static/docs/install/completion.md b/public/static/docs/install/completion.md index 9a2de7cc0d..32a0b8d30a 100644 --- a/public/static/docs/install/completion.md +++ b/public/static/docs/install/completion.md @@ -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 diff --git a/public/static/docs/install/linux.md b/public/static/docs/install/linux.md index 7b1dc51983..dbeb25df26 100644 --- a/public/static/docs/install/linux.md +++ b/public/static/docs/install/linux.md @@ -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
diff --git a/public/static/docs/user-guide/contributing/docs.md b/public/static/docs/user-guide/contributing/docs.md index 496ecdc5e5..ed5da25360 100644 --- a/public/static/docs/user-guide/contributing/docs.md +++ b/public/static/docs/user-guide/contributing/docs.md @@ -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, gif, 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. + (`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. From 52be5a18478fb33e3eb82f862db19e6a52d5de48 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 22 Jan 2020 11:38:07 -0600 Subject: [PATCH 2/4] Update public/static/docs/install/linux.md --- public/static/docs/install/linux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/static/docs/install/linux.md b/public/static/docs/install/linux.md index dbeb25df26..e67f7ba023 100644 --- a/public/static/docs/install/linux.md +++ b/public/static/docs/install/linux.md @@ -56,7 +56,7 @@ $ snap install --classic dvc Add `--edge` to install the latest beta (master) version. -> When connected to the internet, `snap` will automatically look for updates +> 💡 When connected to the internet, `snap` will automatically look for updates > every 6 hours. ## Install from repository From d2960b01e326c7743ab7f9b5ecc7be00229a97f3 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 22 Jan 2020 11:40:50 -0600 Subject: [PATCH 3/4] Update public/static/docs/user-guide/contributing/docs.md --- public/static/docs/user-guide/contributing/docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/static/docs/user-guide/contributing/docs.md b/public/static/docs/user-guide/contributing/docs.md index ed5da25360..3421165bd1 100644 --- a/public/static/docs/user-guide/contributing/docs.md +++ b/public/static/docs/user-guide/contributing/docs.md @@ -14,7 +14,7 @@ To contribute documentation, these are the relevant locations under (`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) - (`img/`): Add new images, gif, svg, etc here. Reference them from the Markdown + (`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. From c4684f957ac060281a93fc6748c1aac3d10e4e07 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 22 Jan 2020 11:42:33 -0600 Subject: [PATCH 4/4] Update public/static/docs/user-guide/contributing/docs.md --- public/static/docs/user-guide/contributing/docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/static/docs/user-guide/contributing/docs.md b/public/static/docs/user-guide/contributing/docs.md index 3421165bd1..039ee12ac0 100644 --- a/public/static/docs/user-guide/contributing/docs.md +++ b/public/static/docs/user-guide/contributing/docs.md @@ -17,7 +17,7 @@ To contribute documentation, these are the relevant locations under (`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.