From 3f90c4cefc4a9c07894ec9b3d93b4956411b215f Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 26 Aug 2019 17:16:30 -0500 Subject: [PATCH 1/5] get-started: remove redundant info from retrieve-data chapter --- static/docs/get-started/retrieve-data.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/static/docs/get-started/retrieve-data.md b/static/docs/get-started/retrieve-data.md index 9486bfa395..417d33d40a 100644 --- a/static/docs/get-started/retrieve-data.md +++ b/static/docs/get-started/retrieve-data.md @@ -9,26 +9,15 @@ To retrieve data files into the workspace in your local machine, run: ```dvc +$ rm -f data/data.xml $ dvc pull ``` -> If you've followed previous chapters of this section, try deleting -> `data/data.xml` before running the command above, otherwise DVC won't find a -> need to [checkout](/doc/commands-reference/checkout) the file, since it's -> already in your workspace. - This command retrieves data files that are referenced in all [DVC-files](/doc/user-guide/dvc-file-format) in the project. So, you usually run it after `git clone`, `git pull`, or `git checkout`. -As an easy way to test it: - -```dvc -$ rm -f data/data.xml -$ dvc pull -``` - -Alternatively, if you want to retrieve a single dataset or a file: +Alternatively, if you want to retrieve a single dataset or a file you can use: ```dvc $ dvc pull data/data.xml.dvc From 963d0beb744378ce3c291f4cd9251778f5d55247 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 27 Aug 2019 17:44:12 -0500 Subject: [PATCH 2/5] get-started: Improve note in reproduce chapter --- static/docs/get-started/reproduce.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/static/docs/get-started/reproduce.md b/static/docs/get-started/reproduce.md index b4cd3d042d..642f3db9d3 100644 --- a/static/docs/get-started/reproduce.md +++ b/static/docs/get-started/reproduce.md @@ -20,8 +20,9 @@ $ dvc repro train.dvc > If you've just followed the previous chapters, the command above will have > nothing to reproduce since you've already run all the pipeline stages. To -> easily try this command, you can clone this example -> [Github project](https://github.com/iterative/example-get-started) first. +> easily try this command, clone this example +> [Github project](https://github.com/iterative/example-get-started) and run it +> from there. `train.dvc` file internally describes what data files and code we should take and how to run the command to get the binary model file. For each data file it From 7d3e03819e235afcddf774cab7428e735513cf54 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 29 Aug 2019 00:38:08 -0500 Subject: [PATCH 3/5] cmd ref: update options in get and import --- static/docs/commands-reference/get.md | 7 +++++++ static/docs/commands-reference/import.md | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/static/docs/commands-reference/get.md b/static/docs/commands-reference/get.md index cef60ad606..d3d652ed7b 100644 --- a/static/docs/commands-reference/get.md +++ b/static/docs/commands-reference/get.md @@ -37,6 +37,13 @@ created in the current working directory, with its original file name. ## Options +- `-o`, `--out` - specify a path (directory and file name) to the desired + location to place the imported data in. The default value (when this option + isn't used) is the current working directory (`.`) and original file name. + +- `--rev` - specific Git revision of the DVC repository to import the data from. + `HEAD` by default. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/static/docs/commands-reference/import.md b/static/docs/commands-reference/import.md index e5d3395fe3..86e99838a2 100644 --- a/static/docs/commands-reference/import.md +++ b/static/docs/commands-reference/import.md @@ -57,9 +57,9 @@ downloaded data artifact from the external DVC repo. ## Options -- `-o`, `--out` - specify a location in the workspace to place the imported data - in, as a path to the desired directory. The default value (when this option - isn't used) is the current working directory (`.`). +- `-o`, `--out` - specify a path (directory and file name) to the desired + location to place the imported data in. The default value (when this option + isn't used) is the current working directory (`.`) and original file name. - `--rev` - specific Git revision of the DVC repository to import the data from. `HEAD` by default. From 56f816ffd77de5239874b2aae816347c892cc44d Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 29 Aug 2019 23:54:29 -0500 Subject: [PATCH 4/5] Review usage of term "step" (use "stage" when referring to pipelines). for https://github.com/iterative/dvc.org/issues/448#issue-459433302 --- static/docs/changelog/0.35.md | 2 +- static/docs/commands-reference/checkout.md | 6 ++-- static/docs/commands-reference/commit.md | 36 ++++++++++--------- static/docs/commands-reference/get-url.md | 7 ++-- static/docs/commands-reference/import-url.md | 11 +++--- static/docs/commands-reference/move.md | 21 +++++------ static/docs/get-started/configure.md | 4 +-- static/docs/get-started/example-versioning.md | 21 ++++++----- static/docs/get-started/index.md | 12 +++---- static/docs/get-started/retrieve-data.md | 7 ++-- static/docs/tutorial/define-ml-pipeline.md | 30 ++++++++-------- static/docs/tutorial/preparation.md | 4 +-- static/docs/tutorial/reproducibility.md | 11 +++--- static/docs/user-guide/autocomplete.md | 9 +++-- .../user-guide/contributing-documentation.md | 9 +++-- static/docs/user-guide/contributing.md | 8 ++--- 16 files changed, 102 insertions(+), 96 deletions(-) diff --git a/static/docs/changelog/0.35.md b/static/docs/changelog/0.35.md index 5d7343d386..a52b7430c6 100644 --- a/static/docs/changelog/0.35.md +++ b/static/docs/changelog/0.35.md @@ -15,7 +15,7 @@ improvements) we have done in the last few months: - 📖 The [Get Started](/doc/get-started/agenda) section has been simplified (e.g. to use tags instead of branches) and extended. We have also prepared a [Github DVC project ](https://github.com/iterative/example-get-started)that - reflects the sequence of steps in the “get started” guide. You can now + reflects the sequence of chapters in the “get started” guide. You can now download the whole project and reproduce all the models. - **`dvc diff`** **command introduced**. Summary statistics for the diff --git a/static/docs/commands-reference/checkout.md b/static/docs/commands-reference/checkout.md index 63abdd3a18..66480796ef 100644 --- a/static/docs/commands-reference/checkout.md +++ b/static/docs/commands-reference/checkout.md @@ -235,6 +235,6 @@ $ md5 model.pkl MD5 (model.pkl) = 3863d0e317dee0a55c4e59d2ec0eef33 ``` -Previously this took two steps, `git checkout` followed by `dvc checkout`, but -we have skipped having to remember to run that second step. Instead it is -automatically executed for us, and the workspace is automatically synchronized. +Previously this took two steps, `git checkout` followed by `dvc checkout`. We +can now skip the second one, which is automatically executed for us. The +workspace is automatically synchronized accordingly. diff --git a/static/docs/commands-reference/commit.md b/static/docs/commands-reference/commit.md index bcf75789d2..ded23eae12 100644 --- a/static/docs/commands-reference/commit.md +++ b/static/docs/commands-reference/commit.md @@ -1,7 +1,8 @@ # commit Record changes to the repository by updating -[DVC-files](/doc/user-guide/dvc-file-format) and saving outputs to cache. +[DVC-files](/doc/user-guide/dvc-file-format) and saving outputs to +cache. ## Synopsis @@ -19,8 +20,9 @@ positional arguments: The `dvc commit` command is useful for several scenarios where a dataset is being changed: when a [stage](/doc/commands-reference/run) or [pipeline](/doc/commands-reference/pipeline) is in development, when one wishes -to run commands outside the control of DVC, or to force DVC-file updates to save -time tying stages or a pipeline. +to run commands outside the control of DVC, or to force +[DVC-file](/doc/user-guide/dvc-file-format) updates to save time tying stages or +a pipeline. - Code or data for a stage is under active development, with rapid iteration of code, configuration, or data. Run DVC commands (`dvc run`, `dvc repro`, and @@ -46,8 +48,9 @@ DVC-files and save data to cache. They are still useful, but keep in mind that DVC can't guarantee reproducibility in those cases – You commit any data you want. Let's take a look at what is happening in the fist scenario closely: -Normally DVC commands like `dvc add`, `dvc repro` or `dvc run`, commit the data -to the DVC cache as the last step. What _commit_ means is that DVC: +Normally DVC commands like `dvc add`, `dvc repro` or `dvc run` commit the data +to the DVC cache after creating a DVC-file. What _commit_ means is +that DVC: - Computes a checksum for the file/directory - Enters the checksum and file name into the DVC-file @@ -56,13 +59,13 @@ to the DVC cache as the last step. What _commit_ means is that DVC: (`dvc init --no-scm`), this does not happen.) - Adds the file/directory or to the DVC cache -There are many cases where the last step is not desirable (usually, rapid -iteration on some experiment). For the DVC commands where available, the -`--no-commit` option prevents the last step from occurring, thus we are saving -time and space by not storing all the data artifacts for every -command attempt. The checksum is still computed and added to the DVC-file, but -the file is not added to the cache. That's where the `dvc commit` command comes -into play. It handles that last step of adding the file to the DVC cache. +There are many cases where the last step is not desirable (for example rapid +iterations on an experiment). The `--no-commit` option prevents the last step +from occurring (on the commands where it's available), saving time and space by +not storing unwanted data artifacts. Checksums is still computed +and added to the DVC-file, but the actual data file is not saved in the DVC +cache. This is where the `dvc commit` command comes into play. It performs that +last step: storing the file in the DVC cache. ## Options @@ -128,8 +131,8 @@ $ dvc pull --all-branches --all-tags Sometimes we want to iterate through multiple changes to configuration, code, or data, trying multiple options to improve the output of a stage. To avoid filling -the DVC cache with undesired intermediate results, we can run a single stage -with `dvc run --no-commit`, or reproduce an entire pipeline using +the DVC cache with undesired intermediate results, we can run a +single stage with `dvc run --no-commit`, or reproduce an entire pipeline using `dvc repro --no-commit`. This prevents data from being pushed to cache. When development of the stage is finished, `dvc commit` can be used to store data files in the DVC cache. @@ -219,7 +222,8 @@ that the new instance of `model.pkl` is in the cache. It is also possible to execute the commands that are executed by `dvc repro` by hand. You won't have DVC helping you, but you have the freedom to run any script -you like, even ones not recorded in a DVC-file. For example: +you like, even ones not recorded in a +[DVC-file](/doc/user-guide/dvc-file-format). For example: ```dvc $ python src/featurization.py data/prepared data/features @@ -228,7 +232,7 @@ $ python src/evaluate.py model.pkl data/features auc.metric ``` As before, `dvc status` will show which the files have changed, and when your -work is finalized `dvc commit` will commit everything to the cache. +work is finalized `dvc commit` will commit everything to the cache. ## Example: Updating dependencies diff --git a/static/docs/commands-reference/get-url.md b/static/docs/commands-reference/get-url.md index 5f9e1af344..738466e3c6 100644 --- a/static/docs/commands-reference/get-url.md +++ b/static/docs/commands-reference/get-url.md @@ -1,7 +1,8 @@ # get-url -Download or copy file or directory from any supported URL (for example `s3://`, -`ssh://`, and other protocols) or local directory to the local file system. +Download or copy a file or directory from any supported URL (for example +`s3://`, `ssh://`, and other protocols) or local directory to the local file +system. > Unlike `dvc import-url`, this command does not track the downloaded data files > (does not create a DVC-file). @@ -18,7 +19,7 @@ positional arguments: ## Description -In some cases it's convenient to get a data file or directory from a remote +In some cases it's convenient to get a data artifact from a remote location into the current working directory, regardless of whether it's a DVC project. The `dvc get-url` command helps the user do just that. diff --git a/static/docs/commands-reference/import-url.md b/static/docs/commands-reference/import-url.md index c27cfe22fa..81d5fab644 100644 --- a/static/docs/commands-reference/import-url.md +++ b/static/docs/commands-reference/import-url.md @@ -1,11 +1,12 @@ # import-url -Download or copy file or directory from any supported URL (for example `s3://`, -`ssh://`, and other protocols) or local directory to the workspace, -and track changes in the remote data source with DVC. Creates a DVC-file. +Download or copy a file or directory from any supported URL (for example +`s3://`, `ssh://`, and other protocols) or local directory to the +workspace, and track changes in the remote data source with DVC. +Creates a DVC-file. -> See also `dvc get-url` which corresponds to the first step this command -> performs (just download the data). +> See also `dvc get-url` which corresponds to the first half of what this +> command does (downloading the data artifact). ## Synopsis diff --git a/static/docs/commands-reference/move.md b/static/docs/commands-reference/move.md index 01d408c4c1..dc9775c612 100644 --- a/static/docs/commands-reference/move.md +++ b/static/docs/commands-reference/move.md @@ -48,20 +48,20 @@ outs: path: data.csv ``` -If we move this using the regular `mv data.csv other.csv` the DVC-file would not -know that we changed the `path` of `data.csv` to `other.csv`. +If we move this using the regular `mv data.csv other.csv` command, DVC wouldn't +know that we changed the `path` of `data.csv` to `other.csv`, as the old +location is still registered in the corresponding DVC-file. -`dvc move` adjusts the content of the DVC-file to update `path`. So that saves -some manual and programming steps. - -To illustrate, notice that `path` value has changed, as well as the DVC-file -name: +`dvc move` adjusts the content of the DVC-file to update `path`. This saves +users from performing several manual operations: ```dvc $ dvc move data.csv other.csv $ cat other.csv.dvc ``` +Notice that `path` value has changed, as well as the DVC-file name. + And here is the updated content of the `other.csv.dvc`: ```yaml @@ -102,9 +102,10 @@ $ tree ``` Here we use `dvc add` to put a file under DVC control. Then we use `dvc move` to -change its location. Note that the `data.csv.dvc` DVC-file is also moved. If -target path already exists and is a directory, data file is moved with unchanged -name into this folder. +change its location. Note that the `data.csv.dvc` +[DVC-file](/doc/user-guide/dvc-file-format) is also moved. If target path +already exists and is a directory, data file is moved with unchanged name into +this folder. ```dvc $ tree diff --git a/static/docs/get-started/configure.md b/static/docs/get-started/configure.md index eed6b49ac4..6f8e064deb 100644 --- a/static/docs/get-started/configure.md +++ b/static/docs/get-started/configure.md @@ -27,8 +27,8 @@ $ dvc remote add -d myremote /tmp/dvc-storage $ git commit .dvc/config -m "Configure local remote" ``` -> We only use a local remote in this guide for simplicity's sake in following -> these basic steps as you are learning to use DVC. We realize that for most +> We only use a local remote in this guide for simplicity's sake when following +> these steps, as you are learning to use DVC. For most > [use cases](/doc/use-cases), other "more remote" types of remotes will be > required. diff --git a/static/docs/get-started/example-versioning.md b/static/docs/get-started/example-versioning.md index 71c9409af5..1c10d4ab5a 100644 --- a/static/docs/get-started/example-versioning.md +++ b/static/docs/get-started/example-versioning.md @@ -336,16 +336,15 @@ changed. Here where DVC pipelines feature comes very handy and was designed for. We touched it briefly when we described `dvc run` and `dvc repro` at the very end. -The next step here would be splitting the script into two steps and utilizing -DVC pipelines. See this [example](/doc/get-started/example-pipeline) to get a -hands-on experience with them and try to apply it here. Don't hesitate to join -our [community](/chat) to ask any questions! - -Another thing, you should have noticed, is the metrics file (`metrics.json`) and -the way we captured it with `-M metrics.json` option. Metric file is a special -type of output DVC provides an interface on top to compare across tags or +The next step here would be splitting the script into two parts, and utilizing +DVC [pipelines](/doc/commands-reference/pipeline). See +[this example](/doc/get-started/example-pipeline) to get a hands-on experience +with pipelines and try to apply it here. Don't hesitate to join our +[community](/chat) to ask any questions! + +Another detail we only brushed on here is the way we captured the `metrics.json` +metrics file with the `-M` option of `dvc run`. Metric files are a special type +of output DVC provides an interface for, in order to compare across Git tags or branches. See `dvc metrics` command and [Compare Experiments](/doc/get-started/compare-experiments) to learn more about -managing metrics. Next step you should try on your own is converting both -iterations we had into `dvc run` and then utilize `dvc metrics show` to compare -them. +managing metrics with DVC. diff --git a/static/docs/get-started/index.md b/static/docs/get-started/index.md index e8c940a31d..b1e6d8bf41 100644 --- a/static/docs/get-started/index.md +++ b/static/docs/get-started/index.md @@ -1,12 +1,12 @@ # Get Started -_Get Started_ is a step by step introduction into basic DVC concepts. It doesn't +_Get Started_ is a step-by-step introduction into basic DVC concepts. It doesn't go into details much, but provides links and expandable sections to learn more. -At the very end there are a few complete step-by-step examples to give you more -hands-on experience with real life scenarios. The first one is about model and -dataset [versioning](/doc/get-started/example-versioning), and the second one is -focused on [pipelines and reproducibility](/doc/get-started/example-pipeline). +At the very end there are a few complete examples to give you more hands-on +experience with real life scenarios. The first one is about model and dataset +[versioning](/doc/get-started/example-versioning), and the second one is focused +on [pipelines and reproducibility](/doc/get-started/example-pipeline). ✅ Please, join our [community](/chat) or see these [support](/support) options if you have any questions or need any help. We are very responsive ⚡. @@ -18,5 +18,5 @@ us a ⭐ if you like the project! [on Patreon](https://www.patreon.com/DVCorg/overview) to support the project. Separate to this section, the longer [Tutorial](/doc/tutorial) also introduces -DVC step-by-step while additionally explaining in great detail the motivation +DVC step-by-step, while additionally explaining in great detail the motivation and what's happening internally. diff --git a/static/docs/get-started/retrieve-data.md b/static/docs/get-started/retrieve-data.md index 417d33d40a..4856148936 100644 --- a/static/docs/get-started/retrieve-data.md +++ b/static/docs/get-started/retrieve-data.md @@ -1,9 +1,8 @@ # Retrieve Data -> Make sure that the steps described in the -> [initialization](/doc/get-started/initialize) and -> [configuration](/doc/get-started/configure) chapters are completed before you -> run the `dvc pull` command in a newly cloned or initialized Git repository. +> You'll need to complete the [initialization](/doc/get-started/initialize) and +> [configuration](/doc/get-started/configure) chapters before being able to run +> the commands explained here. To retrieve data files into the workspace in your local machine, run: diff --git a/static/docs/tutorial/define-ml-pipeline.md b/static/docs/tutorial/define-ml-pipeline.md index 9ea2a2fbe0..0463e49234 100644 --- a/static/docs/tutorial/define-ml-pipeline.md +++ b/static/docs/tutorial/define-ml-pipeline.md @@ -132,8 +132,8 @@ same. ## Running commands Once the data files are in the workspace, you can start processing the data and -train ML models out of the data files. DVC helps you to define steps of your ML -process and pipe them together into a ML +train ML models out of the data files. DVC helps you to define stages of your ML +process and easily connect them into a ML [pipeline](/doc/commands-reference/pipeline). `dvc run` executes any command that you pass into it as a list of parameters. @@ -262,12 +262,12 @@ $ git commit -m "extract data" ## Running in bulk -One single step of our ML pipeline was defined and committed into repository. It -is not necessary to commit steps right after a step's definition. You can run a -few steps and commit them later. +A single stage of our ML pipeline was defined and committed into repository. It +isn't necessary to commit stages right after their creation. You can create a +few and commit them to Git together later. -Let’s run the next step of converting an XML file to TSV and the following step -of separating training and testing datasets one by one: +Let’s run the following stages: converting an XML file to TSV, and then +separating training and testing datasets: ```dvc $ dvc run -d data/Posts.xml -d code/xml_to_tsv.py -d code/conf.py \ @@ -287,8 +287,9 @@ Reproducing 'Posts-test.tsv.dvc': Positive size 2049, negative size 97951 ``` -The result of the steps are two stage files corresponding to each of the -commands: `Posts-test.tsv.dvc` and `Posts.tsv.dvc`. Also, a `code/conf.pyc` file +The result of the commands above are two +[stage files](/doc/commands-reference/run) corresponding to each of the +commands, `Posts-test.tsv.dvc` and `Posts.tsv.dvc`. Also, a `code/conf.pyc` file was created. This type of file should not be tracked by Git. Let’s manually include this type of file into `.gitignore`. @@ -302,7 +303,8 @@ $ git status -s $ echo "*.pyc" >> .gitignore ``` -Both of the steps can be committed to the repository together. +As mentioned before, both of stage files can be committed to the repository +together: ```dvc $ git add . @@ -355,9 +357,9 @@ Reproducing 'Dvcfile': > Note that using `-f Dvcfile` with `dvc run` above isn't necessary as the > default stage file name is `Dvcfile` when there are no outputs (option `-o`). -The model evaluation step is the last one. To help in the pipeline's -reproducibility, we specify stage file name `Dvcfile`. (This will be discussed -in more detail in the next chapter.) +The model evaluation stage is the last one for this tutorial. To help in the +pipeline's reproducibility, we use stage file name `Dvcfile`. (This will be +discussed in more detail in the next chapter.) Note that the output file `data/eval.txt` was transformed by DVC into a metric file in accordance with the `-M` option. @@ -376,7 +378,7 @@ $ git add . $ git commit -m Evaluate ``` -The evaluation step output contains the target metrics value in a simple text +The evaluation stage output contains the target metrics value in a simple text form: ```dvc diff --git a/static/docs/tutorial/preparation.md b/static/docs/tutorial/preparation.md index e5ca72df47..afaac0fe4c 100644 --- a/static/docs/tutorial/preparation.md +++ b/static/docs/tutorial/preparation.md @@ -5,8 +5,8 @@ In this document, we will be building an ML model to classify `python` tag and without `python` tag. For training purposes, a small subset of data will be used — only 180Mb xml files. -Most of the code for the problem is ready and will be downloaded in the first -steps. Later we will be modifying the code a bit to improve the model. +Most of the code to solve this problem is ready to be downloaded. We will be +modifying some of the code during this tutorial to improve the model. ## Getting the sample code diff --git a/static/docs/tutorial/reproducibility.md b/static/docs/tutorial/reproducibility.md index 0ff83f0c11..b60fe34830 100644 --- a/static/docs/tutorial/reproducibility.md +++ b/static/docs/tutorial/reproducibility.md @@ -84,9 +84,9 @@ Reproducing 'Dvcfile': python code/evaluate.py ``` -The process started with the feature creation step because one of its parameters -was changed — the edited source code file `code/featurization.py`. All dependent -stages were ran again as well. +The process started with the feature creation stage because one of its +parameters was changed — the edited source code file `code/featurization.py`. +All dependent stages were ran again as well. Let’s take a look at the metric’s change. The improvement is close to zero (+0.0075% to be precise): @@ -135,7 +135,7 @@ $ git commit -m Bigrams ## Checkout code and data files -The previous experiment was done in the feature extraction step and provided no +The previous experiment was done in the 'featurization' stage and provided no improvements. This might be caused by not having perfect model hyperparameters. Let’s try to improve the model by changing the hyperparameters. @@ -181,7 +181,8 @@ clf = RandomForestClassifier(n_estimators=700, n_jobs=6, random_state=seed) ``` -Only the modeling and the evaluation step need to be reproduced. Just run repro: +Only the modeling and the evaluation stage need to be reproduced. Just run +repro: ```dvc $ dvc repro diff --git a/static/docs/user-guide/autocomplete.md b/static/docs/user-guide/autocomplete.md index 0c10f5bf91..6b1c2e91fc 100644 --- a/static/docs/user-guide/autocomplete.md +++ b/static/docs/user-guide/autocomplete.md @@ -26,18 +26,17 @@ Depending on what you typed on the command line so far, it completes: files to reproduce Depending upon your preference and the availability of both Bash and Zsh on your -system, follow the steps given below to Configure Bash and/or Zsh. +system, follow the steps below to Configure your shell. If you are new to working with shell or uncertain about your active shell, print `$0` to check your active shell. For example: ```dvc $ echo $0 - /bin/bash ``` -In this case, follow these steps to configure Bash, as it is your active shell. +In this example, you would follow the Bash configuration instructions. ## Configure Bash @@ -138,8 +137,8 @@ Then reload your shell: $ exec $SHELL -l ``` -This step is optional but will make look much nicer by adding more colors to it. -Add the following to your `~/.zshrc`: +This step is optional but will make look the DVC output much nicer, by adding +more colors to it. Add the following to your `~/.zshrc`: ```bash # Case insensitive match diff --git a/static/docs/user-guide/contributing-documentation.md b/static/docs/user-guide/contributing-documentation.md index 07ec6ab18f..8aca9ac35a 100644 --- a/static/docs/user-guide/contributing-documentation.md +++ b/static/docs/user-guide/contributing-documentation.md @@ -68,11 +68,10 @@ installed. Install and keep the dependencies up to date by running `npm install` often. This will also enable the Git pre-commit hook that will be formatting your code and documentation files automatically. -It's highly recommended to run the Node.js docs app locally to test significant -changes to the docs before submitting them, and its very much needed in order to -make changes to the docs JavaScript engine itself (rare). These changes need to -be properly formatted as well. This is also ensured in the following steps for -setting up. +It's highly recommended to run the Node docs app locally to check documentation +changes before submitting them, and its very much needed in order to make +changes to the docs JavaScript engine itself (rare). Source code files need to +be properly formatted as well, which is also ensured by the full setup below. Start the development server using `npm run dev` which will start the server on the default port `3000`. Visit `http://localhost:3000/` and navigate to the docs diff --git a/static/docs/user-guide/contributing.md b/static/docs/user-guide/contributing.md index 54aabb0bf8..5837a45247 100644 --- a/static/docs/user-guide/contributing.md +++ b/static/docs/user-guide/contributing.md @@ -127,8 +127,8 @@ $ python -m tests --pdb ## Testing remotes This tests require additional effort to set up, so they are skipped by default. -You don't need this in most cases, however, if you develop or fix some remote -related code you might need to go through steps below. +However, running code tests locally may be necessary when changing core source +code. Install requirements for whatever remotes you are going to test: @@ -167,8 +167,8 @@ Install [aws cli](https://docs.aws.amazon.com/en_us/cli/latest/userguide/cli-chap-install.html) tools. -Set up an account, get credentials, which will have access to S3. When set `ENV` -vars like this: +Set up an account, get credentials, which will have access to S3. Then, set +`ENV` vars like this: ```dvc $ export AWS_ACCESS_KEY_ID="...YOUR-ACCESS-KEY-ID..." From 51a4a05505c3845e0cd7ec643791a85a09a61902 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Thu, 29 Aug 2019 21:45:40 -0800 Subject: [PATCH 5/5] Update 0.35.md --- static/docs/changelog/0.35.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/docs/changelog/0.35.md b/static/docs/changelog/0.35.md index a52b7430c6..c3b1910151 100644 --- a/static/docs/changelog/0.35.md +++ b/static/docs/changelog/0.35.md @@ -14,7 +14,7 @@ improvements) we have done in the last few months: - 📖 The [Get Started](/doc/get-started/agenda) section has been simplified (e.g. to use tags instead of branches) and extended. We have also prepared a - [Github DVC project ](https://github.com/iterative/example-get-started)that + [Github DVC project ](https://github.com/iterative/example-get-started) that reflects the sequence of chapters in the “get started” guide. You can now download the whole project and reproduce all the models.