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.

Sign up for GitHub

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 (March 18) #1072

Merged
merged 15 commits into from
Mar 26, 2020
Merged

Regular updates (March 18) #1072

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
821359c
api ref: update metrics add and remove descs
jorgeorpinel Mar 19, 2020
415901f
cmd ref: update remvoe desc.
jorgeorpinel Mar 19, 2020
5fc3884
cmd ref: update root definition
jorgeorpinel Mar 19, 2020
0f10925
cmd ref: imros to gc
jorgeorpinel Mar 19, 2020
db19c60
cmd ref: update gc --all-commits desc
jorgeorpinel Mar 19, 2020
0e21eec
user-guide: update note about node version for devs
jorgeorpinel Mar 20, 2020
635d6e9
user guide: rec Windows Terminal instead of Cmder
jorgeorpinel Mar 20, 2020
64f2dd9
install: add " around special dvc pip paks
jorgeorpinel Mar 25, 2020
713d327
cmd ref: address pending review about pre-commit config in `install`
jorgeorpinel Mar 25, 2020
9aea269
cmd ref: change header in `dvc install`
jorgeorpinel Mar 25, 2020
1baa84e
user-guide: reinstate Cmder rec for Windows terminal alts. and...
jorgeorpinel Mar 25, 2020
03f7411
user-guide: improve terminal recs for Windows users
jorgeorpinel Mar 25, 2020
1ebcf18
user-guide: remove note about problems with Git on Win and Node on WSL
jorgeorpinel Mar 25, 2020
9aeaa94
user-guide: update Node supported version
jorgeorpinel Mar 26, 2020
1d381eb
user-guide: add links to major WSL problems
jorgeorpinel Mar 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions content/docs/command-reference/gc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ files if no scope options are provided. It means it's user's responsibility to
explicitly provide the right set of options to specify what data is still needed
(so that DVC can figure out what fils can be safely deleted).

One of the scope options, `--workspace`, `--all-branches`, `--all-tags`,
`--all-commits`, or any combination of them must be provided. Each of them
corresponds to the current workspace _and_ a set of commits to analyze what
files, directories and what versions are still needed and should be kept (by
analyzing DVC-files in those commits).
One of the scope options (`--workspace`, `--all-branches`, `--all-tags`,
`--all-commits`) or a combination of them must be provided. Each of them
corresponds to keeping the data for the current workspace, and for a certain set
of commits (determined by reading the DVC-files in them). See the
[Options](#options) section for more details.

Unless the `--cloud` option is used, `dvc gc` does not remove data files from
any remote. This means that any files collected from the local cache can be
Expand Down Expand Up @@ -61,10 +61,11 @@ The default remote is cleaned (see `dvc config core.remote`) unless the
commits as well as the workspace (implies `-w`). Useful for keeping all the
data used in the entire existing commit history of the project.

One of the use cases for this option is to safely delete all temporary data
DVC cached when `dvc run` and/or `dvc repro` were run without committing
changes to DVC-files (thus potentially caching data that is not referenced
from workspace or Git commits).
A use case for this option is to safely delete all temporary data `dvc run`
and/or `dvc repro` cache when used without committing changes (see the `-O` or
`-M`, and `--no-commit` options in those commands). In that scenario, data
that is never referenced from the workspace or from any Git commit can still
be stored in the project's cache).

- `-p <paths>`, `--projects <paths>` - if a single remote or a single cache is
shared among different projects (e.g. a configuration like the one described
Expand Down
3 changes: 1 addition & 2 deletions content/docs/command-reference/metrics/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# metrics add

Mark <abbr>output</abbr> file as a
[project metric](/doc/command-reference/metrics).
Mark a DVC-tracked file as a [project metric](/doc/command-reference/metrics).

## Synopsis

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/metrics/remove.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# metrics remove

Stop tracking a [project metric](/doc/command-reference/metrics): Keeps file
located at `path` as an <abbr>output</abbr>, but removes its metric mark in the
DVC-file.
Remove metric mark on a DVC-tracked file: Keeps file located at `path` as an
<abbr>output</abbr>, but removes its mark as a
[project metric](/doc/command-reference/metrics) in the DVC-file.

## Synopsis

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remove.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# remove

Remove data files or directories tracked by DVC.
Remove DVC-tracked files or directories from the <abbr>workspace</abbr>.

## Synopsis

Expand Down
9 changes: 5 additions & 4 deletions content/docs/command-reference/root.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# root

Return the relative path to the <abbr>DVC project</abbr>.
Return the relative path to the root of the <abbr>DVC project</abbr>.

## Synopsis

Expand All @@ -11,9 +11,10 @@ usage: dvc root [-h] [-q | -v]
## Description

While in sub-directories of the project, sometimes developers may want to refer
some file belonging to another directory. This command returns relative path to
the project root from the current working directory. So this command can be used
to build a path to a dependency file, command, or output.
some file belonging to another directory. This command returns the path to the
root directory of the current <abbr>DVC project</abbr>, relative to the current
working directory. This command can be used to build a path to a dependency
file, command, or output.

## Options

Expand Down
4 changes: 2 additions & 2 deletions content/docs/user-guide/contributing/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ $ git clone [email protected]:<username>/dvc.org.git
$ cd dvc.org
```

Make sure you have the latest version of [Node.js](https://nodejs.org/en/), and
install [Yarn](https://yarnpkg.com/):
Make sure you have a **recent** version of [Node.js](https://nodejs.org/en/),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does "recent" mean?

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Mar 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. I'm not sure what's the oldest version this works on, probably its safe to recommend 10+ cc @iAdramelk ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its easier to revert to "latest" but will always work? We can't guarantee it, maybe we should get specific. But up to you, no strong opinion from my part.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I would just specify explicitly the versions we support

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is info. I don't currently know exactly. I know the std. node provided by apt-get (Ubuntu) is really old so I had to install like this. @iAdramelk could you chime in here please?

Copy link
Member

@shcheklein shcheklein Mar 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have engines specified as

  "engines": {
    "node": "^12.0.0"
  },

in blog (which will be part of the dvc.org soon). @fabiosantoscode and @iAdramelk should have more context - ping them in Slack if needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pinged Fabian but he's probably offline rn. I'm using 12 for now so we can merge this and I can update with whatever they say in another PR later. Going to focus on other doc PRs for now.

and install [Yarn](https://yarnpkg.com/):

```dvc
$ npm install -g yarn
Expand Down