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.

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

DVC File guide reorg/rewrite #2098

Merged
merged 37 commits into from
Jan 27, 2021
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
1e75557
guide: [wip] begin simplified DVC Files structure, update index
jorgeorpinel Jan 16, 2021
1f89c47
guide: make main table spec of .dvc files
jorgeorpinel Jan 16, 2021
00b054d
guide: complete spec tables for .dvc files
jorgeorpinel Jan 16, 2021
5ab997a
Merge branch 'master' into 2.0/pipelines
jorgeorpinel Jan 16, 2021
4db3aad
guide: note that dvc.lock is not human-friendly
jorgeorpinel Jan 16, 2021
2249248
guide: remove DVC File section, reorg/rename corresponsding guides
jorgeorpinel Jan 16, 2021
fedddd3
guide: give Tracking Existing Data a proper guide intro, and
jorgeorpinel Jan 16, 2021
d23a42e
guide: make new dvc.yaml guide skeleton (proposal)
jorgeorpinel Jan 16, 2021
014e884
guide: remove old DVC File index
jorgeorpinel Jan 16, 2021
01c6d24
guide: copy edits
jorgeorpinel Jan 16, 2021
2394da2
guide: make dvc.yaml guide+ref structure and write first half
jorgeorpinel Jan 16, 2021
03595ef
Merge branch 'master' into 2.0/pipelines +
jorgeorpinel Jan 16, 2021
959a1f5
Merge branch 'master' into 2.0/pipelines
jorgeorpinel Jan 19, 2021
807a0f7
guide: create Project Structure section for all DVC files info + redi…
jorgeorpinel Jan 19, 2021
ad74328
guide: complete dvc.yaml guide inner struct
jorgeorpinel Jan 19, 2021
44861cb
guide: Project Structure title updates
jorgeorpinel Jan 19, 2021
e4604c9
guide: cover params in dvc.yaml
jorgeorpinel Jan 19, 2021
7e5dc15
guide: reorg Project Structure pages
jorgeorpinel Jan 20, 2021
846ef92
guide: consolidate first few dvc.yaml guide sections into ## Stages
jorgeorpinel Jan 20, 2021
79a4bcf
guide: more reorg and copy edits in Project Structure
jorgeorpinel Jan 20, 2021
132bae7
guide: finish metrics&plots and update bad links for dvc.yaml guide
jorgeorpinel Jan 20, 2021
2663e67
guide: add index for Project Structure
jorgeorpinel Jan 20, 2021
6f0ea6d
guide: finish dvc.yaml spec tables
jorgeorpinel Jan 20, 2021
7a7703b
guide: concentrate advanced dvc.yaml info
jorgeorpinel Jan 20, 2021
db9832c
guide: clarifications to dvc.yaml
jorgeorpinel Jan 21, 2021
3562e26
Merge branch 'master' into 2.0/pipelines
jorgeorpinel Jan 24, 2021
f5a2e53
typo in redirects list
jorgeorpinel Jan 24, 2021
c055a79
guide: make UG/PS index look like nav, add dvc.yaml details
jorgeorpinel Jan 24, 2021
be44b10
guide: make ToC in .dvc files
jorgeorpinel Jan 24, 2021
3c5ed8c
guide: rename .dvc file sections
jorgeorpinel Jan 24, 2021
9c7ea27
guide: add term "parameterization" to dvc.yaml/Templating
jorgeorpinel Jan 24, 2021
db21a2c
guide: add 2.0 warning to advanced dvc.yaml feats
jorgeorpinel Jan 24, 2021
82bb3eb
guide: copy edits
jorgeorpinel Jan 24, 2021
b1efa77
guide: copy edits
jorgeorpinel Jan 25, 2021
9ce16cd
guide: typos in dvc.yaml
jorgeorpinel Jan 25, 2021
17b3324
guide: fix a dvc.yaml sample
jorgeorpinel Jan 25, 2021
983a2c3
guide: fix links
jorgeorpinel Jan 25, 2021
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
4 changes: 2 additions & 2 deletions content/docs/command-reference/params/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ The `dvc params diff` command is available to show parameter changes, displaying
their current and previous values.

💡 Parameters can also be used for
[templating](/doc/user-guide/dvc-files/advanced-dvc.yaml#templating) `dvc.yaml`
itself.
[templating](/doc/user-guide/project-structure/pipelines-files#templating)
`dvc.yaml` itself.

## Options

Expand Down
33 changes: 16 additions & 17 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,34 +89,33 @@
"children": [
{
"label": "What is DVC?",
"slug": "what-is-dvc",
"source": "what-is-dvc.md"
"slug": "what-is-dvc"
},
{
"label": "DVC Files",
"slug": "dvc-files",
"slug": "project-structure",
"source": "user-guide/project-structure/index.md",
"children": [
{
"label": ".dvc files",
"slug": ".dvc"
"label": "Pipelines Files (dvc.yaml)",
"slug": "pipelines-files"
},
{
"label": "dvc.yaml & dvc.lock",
"slug": "dvc-yaml"
"label": ".dvc Files",
"slug": "dvc-files"
},
{
"label": "Advanced dvc.yaml",
"slug": "advanced-dvc-yaml"
"label": ".dvcignore Files",
"slug": "dvcignore-files",
"tutorials": {
"katacoda": "https://katacoda.com/dvc/courses/examples/dvcignore"
}
},
{
"label": "Internal Files",
"slug": "internal-files"
}
]
},
"dvc-internals",
{
"slug": "dvcignore",
"tutorials": {
"katacoda": "https://katacoda.com/dvc/courses/examples/dvcignore"
}
},
{
"label": "How To",
"slug": "how-to",
Expand Down
6 changes: 3 additions & 3 deletions content/docs/start/data-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ $ dvc add data/data.xml

DVC stores information about the added file (or a directory) in a special `.dvc`
file named `data/data.xml.dvc`, a small text file with a human-readable
[format](/doc/user-guide/dvc-files/.dvc). This file can be easily versioned like
source code with Git, as a placeholder for the original data (which gets listed
in `.gitignore`):
[format](/doc/user-guide/project-structure/dvc-files). This file can be easily
versioned like source code with Git, as a placeholder for the original data
(which gets listed in `.gitignore`):

```dvc
$ git add data/data.xml.dvc data/.gitignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ then `git commit` `.dvc` files that contain file hashes that point to cached
data.

In this case we created `data.dvc` and `model.h5.dvc`. Refer to
[DVC Files](/doc/user-guide/dvc-files#dvc-files) to learn more about how these
files work.
[DVC Files](/doc/user-guide/project-structure/dvc-files) to learn more about how
these files work.

</details>

Expand Down
257 changes: 0 additions & 257 deletions content/docs/user-guide/dvc-files.md

This file was deleted.

Loading