From 8a812fddf6935d76587d6db0a519e7e3b324bd9d Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Feb 2020 19:45:09 -0600 Subject: [PATCH 1/3] cmd ref: update short desc with simpler terms per https://github.com/iterative/dvc/pull/3277#pullrequestreview-352650016 --- public/static/docs/command-reference/get.md | 4 ++-- public/static/docs/command-reference/import.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/public/static/docs/command-reference/get.md b/public/static/docs/command-reference/get.md index 3d155b32fa..78a541a81c 100644 --- a/public/static/docs/command-reference/get.md +++ b/public/static/docs/command-reference/get.md @@ -1,7 +1,7 @@ # get -Download a file or directory from any DVC repository or plain Git -repository into the current working directory. +Download a file or directory tracked by DVC or by Git into the current working +directory. > Unlike `dvc import`, this command does not track the downloaded files (does > not create a DVC-file). diff --git a/public/static/docs/command-reference/import.md b/public/static/docs/command-reference/import.md index cf86488d9c..30dedc63ba 100644 --- a/public/static/docs/command-reference/import.md +++ b/public/static/docs/command-reference/import.md @@ -1,7 +1,7 @@ # import -Download a file or directory from any DVC repository or plain Git -repository into the workspace. It also creates a +Download a file or directory tracked by DVC or by Git into the +workspace. It also creates a [DVC-file](/doc/user-guide/dvc-file-format) with information about the data source, which can later be used to [update](/doc/command-reference/update) the import. From 00bbdb4b3bb2b7fba6ca37f9986a3798d77361df Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Feb 2020 20:34:00 -0600 Subject: [PATCH 2/3] ci: redule number of links that need to be excluded and improve some config file comments --- .circleci/config.yml | 19 +++++++++---------- .../docs/understanding-dvc/how-it-works.md | 4 ++-- .../use-cases/sharing-data-and-model-files.md | 2 +- scripts/exclude-links.txt | 7 +------ src/utils/sidebar.js | 2 +- src/utils/sidebar.test.js | 4 ++-- 6 files changed, 16 insertions(+), 22 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 2f709db332..4429921a80 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,26 +1,25 @@ # Javascript Node CircleCI 2.0 configuration file # -# Check https://circleci.com/docs/2.0/language-javascript/ for more details +# See https://circleci.com/docs/2.0/language-javascript/ for more details. # version: 2.1 defaults: &defaults working_directory: ~/repo docker: - # specify the version you desire here + # Specify the version you desire here. - image: circleci/node:10.16.3 - # Specify service dependencies here if necessary - # CircleCI maintains a library of pre-built images - # documented at https://circleci.com/docs/2.0/circleci-images/ - # - image: circleci/mongo:3.4.4 + # Specify service dependencies here if necessary. + # CircleCI maintains a library of pre-built images, + # documented in https://circleci.com/docs/2.0/circleci-images/ commands: install: steps: - checkout - # CircleCI breaks master branch which affects format check below + # CircleCI breaks master branch which affects format check below. See # https://discuss.circleci.com/t/checkout-script-adds-commits-to-master-from-circle-branch/14194 - run: name: restore master @@ -29,11 +28,11 @@ commands: git reset --hard origin/master git checkout - - # Download cached dependencies + # Download cached dependencies. - restore_cache: keys: - v1-dependencies-{{ checksum "yarn.lock" }} - # fallback to using the latest cache if no exact match is found + # Fallback to using the latest cache if no exact match is found. - v1-dependencies- - run: @@ -44,7 +43,7 @@ commands: cache: steps: - # Upload dependencies cache + # Upload dependencies cache. - save_cache: paths: - node_modules diff --git a/public/static/docs/understanding-dvc/how-it-works.md b/public/static/docs/understanding-dvc/how-it-works.md index 2701aff59f..2df17f9eb7 100644 --- a/public/static/docs/understanding-dvc/how-it-works.md +++ b/public/static/docs/understanding-dvc/how-it-works.md @@ -60,7 +60,7 @@ any Git server, and allow for experiments to be easily reproduced: ```dvc - $ git clone https://github.com/dataversioncontrol/myrepo.git + $ git clone https://github.com/example/project.git $ cd myrepo # Reproduce data files $ dvc repro @@ -80,7 +80,7 @@ $ dvc push # push from the cache to remote storage # On a colleague's machine: - $ git clone https://github.com/dataversioncontrol/myrepo.git + $ git clone https://github.com/example/project.git $ cd myrepo $ git pull # download tracked data from remote storage $ dvc checkout # checkout data files diff --git a/public/static/docs/use-cases/sharing-data-and-model-files.md b/public/static/docs/use-cases/sharing-data-and-model-files.md index ce16ceadf8..2e64db59b5 100644 --- a/public/static/docs/use-cases/sharing-data-and-model-files.md +++ b/public/static/docs/use-cases/sharing-data-and-model-files.md @@ -77,7 +77,7 @@ Please use regular Git commands to download code and DVC-files from your Git servers. For example: ```dvc -$ git clone https://github.com/myaccount/myproject.git +$ git clone https://github.com/example/project.git $ cd myproject ``` diff --git a/scripts/exclude-links.txt b/scripts/exclude-links.txt index cfb3bfb3d6..1e268d5f9e 100644 --- a/scripts/exclude-links.txt +++ b/scripts/exclude-links.txt @@ -4,17 +4,15 @@ https://$ https://api.github.com/repos/$ https://blog.$ https://discuss.$ -https://dvc.org/some.link https://example.com/data.txt https://example.com/path/to/data https://example.com/path/to/data.csv https://example.com/path/to/dir https://github.com/$ -https://github.com/dataversioncontrol/myrepo.git +https://github.com/example/project.git https://github.com/example/registry https://github.com/iterative/dvc.org/blob/master/public$ https://github.com/iterative/dvc/releases/download/$ -https://github.com/myaccount/myproject.git https://myendpoint.com https://object-storage.example.com https://www.youtube.com/embed/$ @@ -25,8 +23,5 @@ https://drive.google.com/drive/folders/0AIac4JZqHhKmUk9PDA http://millionsongdataset.com/pages/getting-dataset/#subset https://circleci.com/gh/iterative/dvc.org https://s3-us-east-2.amazonaws.com/dvc-s3-repo/ -https://www.katacoda.com/loodse/courses/docker/docker-02-install -https://www.katacoda.com/loodse/courses/dvc/dvc-01-install https://marketplace.visualstudio.com/items?itemName=stkb.rewrap https://www.kaggle.com/rtatman/kerneld4769833fe - diff --git a/src/utils/sidebar.js b/src/utils/sidebar.js index 0135d87975..8336e0c356 100644 --- a/src/utils/sidebar.js +++ b/src/utils/sidebar.js @@ -12,7 +12,7 @@ prev: "/doc/get-started/configure", next: "/doc/get-started/share-data", tutorials: { - katacoda: "https://www.katacoda.com/loodse/courses/docker/docker-02-install" + katacoda: "https://www.katacoda.com/dvc/courses/get-started/initialize" } children: [] } diff --git a/src/utils/sidebar.test.js b/src/utils/sidebar.test.js index c8f977de3e..0147999d4a 100644 --- a/src/utils/sidebar.test.js +++ b/src/utils/sidebar.test.js @@ -88,7 +88,7 @@ describe('SidebarMenu/helper', () => { slug: 'item-name', tutorials: { katacoda: - 'https://www.katacoda.com/loodse/courses/dvc/dvc-01-install' + 'https://www.katacoda.com/dvc/courses/get-started/initialize' } } ] @@ -99,7 +99,7 @@ describe('SidebarMenu/helper', () => { source: '/static/docs/item-name.md', tutorials: { katacoda: - 'https://www.katacoda.com/loodse/courses/dvc/dvc-01-install' + 'https://www.katacoda.com/dvc/courses/get-started/initialize' }, prev: undefined, next: undefined From 083446fb51b86c0591360e5e38eb48a4aaf8b747 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 7 Feb 2020 01:46:43 -0600 Subject: [PATCH 3/3] ci: complete and abc sort scripts/exclude-links.txt for #974 --- scripts/exclude-links.txt | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/scripts/exclude-links.txt b/scripts/exclude-links.txt index 1e268d5f9e..2fecf91512 100644 --- a/scripts/exclude-links.txt +++ b/scripts/exclude-links.txt @@ -1,27 +1,43 @@ http://127.0.0.1:10000/devstoreaccount1; -http://localhost:3000/ -https://$ +https://s3-us-east-2.amazonaws.com/dvc-public/code/foo/bar +https://s3-us-east-2.amazonaws.com/dvc-public/data/foo/bar +https://s3-us-east-2.amazonaws.com/dvc-public/remote/foo/bar +https://s3-us-east-2.amazonaws.com/dvc-s3-repo/ +https://s3-us-east-2.amazonaws.com/dvc-s3-repo/deb/foo +https://s3-us-east-2.amazonaws.com/dvc-s3-repo/rpm/foo https://api.github.com/repos/$ https://blog.$ +https://circleci.com/gh/iterative/dvc.org https://discuss.$ +https://dvc.org/foo +https://dvc.org/static/img/.gif +https://dvc.org/doc/command-reference/foo +https://code.dvc.org/foo/bar +https://data.dvc.org/foo/bar +https://man.dvc.org/foo +https://remote.dvc.org/foo/bar +https://remote.dvc.org/get-started +https://www.dvc.org/foo https://example.com/data.txt +https://example.com/foo +https://example.com/foo/bar?baz https://example.com/path/to/data https://example.com/path/to/data.csv https://example.com/path/to/dir +https://example.com/path/to/file https://github.com/$ https://github.com/example/project.git https://github.com/example/registry https://github.com/iterative/dvc.org/blob/master/public$ https://github.com/iterative/dvc/releases/download/$ -https://myendpoint.com -https://object-storage.example.com -https://www.youtube.com/embed/$ https://accounts.google.com/o/oauth2/auth -http://ogp.me/ns# -https://remote.dvc.org/get-started https://drive.google.com/drive/folders/0AIac4JZqHhKmUk9PDA +https://www.kaggle.com/rtatman/kerneld4769833fe +http://localhost:3000/ http://millionsongdataset.com/pages/getting-dataset/#subset -https://circleci.com/gh/iterative/dvc.org -https://s3-us-east-2.amazonaws.com/dvc-s3-repo/ +https://myendpoint.com +https://object-storage.example.com +http://ogp.me/ns# https://marketplace.visualstudio.com/items?itemName=stkb.rewrap -https://www.kaggle.com/rtatman/kerneld4769833fe +https://www.youtube.com/embed/$ +https://$