-
Notifications
You must be signed in to change notification settings - Fork 394
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.
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
how-to: further improvements #1976
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 8 additions & 7 deletions
15
content/docs/user-guide/how-to/add-deps-or-outs-to-a-stage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 8 additions & 2 deletions
10
content/docs/user-guide/merge-conflicts.md → ...docs/user-guide/how-to/merge-conflicts.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: 'How to Stop Tracking Data' | ||
description: 'You can "un-track" files or directories added in error.' | ||
--- | ||
|
||
# How to Stop Tracking Data | ||
|
||
There are situations where you may want to "un-track" files or directories added | ||
in error to DVC. | ||
|
||
<details> | ||
|
||
## Expand to add a sample data `data.csv` file | ||
|
||
`dvc add` creates a `.dvc` file to track the file, and lists it in `.gitignore`: | ||
|
||
```dvc | ||
$ dvc add data.csv | ||
|
||
$ ls | ||
data.csv data.csv.dvc | ||
$ cat .gitignore | ||
/data.csv | ||
``` | ||
|
||
</details> | ||
|
||
Let's undo `dvc add` with `dvc remove`. This deletes the `.dvc` file (and | ||
corresponding `.gitignore` entry). The data file is now no longer being tracked | ||
after this: | ||
|
||
```dvc | ||
$ dvc remove data.csv.dvc | ||
|
||
$ git status | ||
Untracked files: | ||
data.csv | ||
``` | ||
|
||
You can run `dvc gc` with the `-w` option to remove the data (and all of it's | ||
previous versions, if any) from the <abbr>cache</abbr>: | ||
|
||
```dvc | ||
$ dvc gc -w | ||
``` | ||
|
||
> Note that a very similar procedure works for `dvc.yaml` stages and their | ||
> outputs. |
14 changes: 10 additions & 4 deletions
14
...user-guide/how-to/update-tracked-files.md → .../user-guide/how-to/update-tracked-data.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,7 +29,9 @@ | |
|
||
"^/doc/use-cases/data-and-model-files-versioning/?$ /doc/use-cases/versioning-data-and-model-files", | ||
"^/doc/user-guide/dvc-file-format$ /doc/user-guide/dvc-files-and-directories", | ||
"^/doc/user-guide/updating-tracked-files$ /doc/user-guide/how-to/update-tracked-files", | ||
"^/doc/user-guide/updating-tracked-files$ /doc/user-guide/how-to/update-tracked-data", | ||
"^/doc/user-guide/how-to/update-tracked-files$ /doc/user-guide/how-to/update-tracked-data", | ||
"^/doc/user-guide/merge-conflicts$ /doc/user-guide/how-to/merge-conflicts", | ||
Comment on lines
+33
to
+34
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note for self:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oops, can't right now: https://support.google.com/webmasters/answer/6211453#url_inspection Will try in a few days... |
||
"^/doc/understanding-dvc(/.*)?$ /doc/user-guide/what-is-dvc", | ||
"^/doc/commands-reference(/.*)?$ /doc/command-reference$1", | ||
"^/doc/command-reference/plot$ /doc/command-reference/plots", | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feels like this lonely guide could also be a how-to, at least until we expand on all the other types and figure out where to put them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Putting "how to" before the title doesn't make it a how-to, the content has to be short recipes to address specific problems. The ones you mention are 50% + explanation (and not very short), the remaining part is examples. That doesn't really count (:
How to Setup Remotes also includes some explanation, but mostly how-to stuff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess you could argue it's a lot of explanation actually. Ok, let's leave it as a guide!