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

Draft new get started. #4375

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/docs/command-reference/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ files summary: 1 added, 0 deleted, 0 modified

[2-track-data]:
https://github.com/iterative/example-get-started/releases/tag/2-track-data
[data versioning]: /doc/start/data-management/data-versioning
[data versioning]: /doc/start/data/data-versioning

## Example: Comparing tags or branches

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ or `dvc exp diff`, and before committing it to Git (making it [persistent].
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
5 changes: 2 additions & 3 deletions content/docs/command-reference/exp/branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ version.
https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
[regular commits]: /doc/user-guide/experiment-management/persisting-experiments
[checkpoint experiments]: /doc/command-reference/exp/run#checkpoints
[stored and shared]:
/doc/start/data-management/data-versioning#storing-and-sharing
[stored and shared]: /doc/start/data/data-versioning#storing-and-sharing

## Options

Expand All @@ -60,7 +59,7 @@ version.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ all the current experiments (without comparisons).
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ separately to delete it.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ options below).
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ pushed experiment.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ with the experiments to [remote storage], unless `--no-cache` is used.
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/save.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ $ dvc exp show ...
This example is based on [our Get Started], where you can find the actual source
code.

[our get started]: /doc/start/experiment-management/experiments
[our get started]: /doc/start/experiments/experiments

</admon>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,4 +213,4 @@ Untracked files:

[get started example repo]: https://github.com/iterative/example-get-started
[switching between versions]:
/doc/start/data-management/data-versioning#switching-between-versions
/doc/start/data/data-versioning#switching-between-versions
4 changes: 2 additions & 2 deletions content/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ allows DVC to determine whether it's necessary to download it again.
You may want to get out of and remove the `example-get-started/` directory after
trying this example (especially if trying out the following one).

[versioning basics]: /doc/start/data-management/data-versioning
[versioning basics]: /doc/start/data/data-versioning

## Example: Detecting external file changes

Expand Down Expand Up @@ -348,7 +348,7 @@ $ unzip code.zip
$ rm -f code.zip
```

[data processing section]: /doc/start/data-management/data-pipelines
[data processing section]: /doc/start/pipelines/building-pipelines

<details>

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ file.
`dvc freeze`), use `dvc update` to bring the import up to date from the data
source.

[version the data]: /doc/start/data-management/data-versioning
[version the data]: /doc/start/data/data-versioning

## Options

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/plots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ PNG, or SVG images found in your project. Typically these are artifacts of an
Plots have to be defined either at the stage level, or at the pipeline level in
`dvc.yaml`.

[ml pipeline]: /doc/start/data-management/data-pipelines
[ml pipeline]: /doc/start/pipelines/building-pipelines
[dvclive]: /doc/dvclive

<admon icon="book">
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ these commands.
and links (or copies) the files or directories to the <abbr>workspace</abbr>
(refer to `dvc config cache.type`).

[data sharing]: /doc/start/data-management/data-versioning#storing-and-sharing
[data sharing]: /doc/start/data/data-versioning#storing-and-sharing

<admon type="info">

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ these commands.
> Those should be uploaded with `git push`. `dvc import` data is also ignored by
> this command.

[data sharing]: /doc/start/data-management/data-versioning#storing-and-sharing
[data sharing]: /doc/start/data/data-versioning#storing-and-sharing

The `dvc remote` used is determined in order, based on

Expand Down
3 changes: 2 additions & 1 deletion content/docs/command-reference/repro.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,8 @@ up-to-date and only execute the final stage.
## Examples

> To get hands-on experience with data science and machine learning pipelines,
> see [Get Started: Data Pipelines](/doc/start/data-management/data-pipelines).
> see
> [Get Started: Building Pipelines](/doc/start/pipelines/building-pipelines).

Let's build and reproduce a simple pipeline. It takes this `text.txt` file:

Expand Down
4 changes: 2 additions & 2 deletions content/docs/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@ that is installed when `yarn` runs (see [dev env](#development-environment)).
- `dvc` can be used to show examples of commands and their output in a
terminal session.
- `dvctable` is used for creating colored, bold, or italic table cells. (You
can see an [example](/doc/start/experiment-management/experiments) of
`dvctable` in our "Get Started" section.)
can see an [example](/doc/start/experiments/experiments) of `dvctable` in
our "Get Started" section.)
- `yaml` is used to show samples of <abbr>DVC files</abbr>, or other YAML
contents.
- `diff` is used mainly for examples of `git diff` output.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/dvclive/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ main Dec 06, 2022 - - - -
$ dvc plots diff $(dvc exp list --name-only)
```

![plots diff](/img/dvclive_exp_tracking_plots_diff.svg)
![plots diff](/img/dvclive_exp_tracking_plots_diff.png)
daavoo marked this conversation as resolved.
Show resolved Hide resolved

</tab>

Expand Down
21 changes: 9 additions & 12 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,22 +40,19 @@
"source": "start/index.md",
"children": [
{
"slug": "data-management",
"slug": "data",
"source": false,
"children": [
"data-versioning",
"data-and-model-access",
"data-pipelines",
{
"label": "Metrics, Parameters, and Plots",
"slug": "metrics-parameters-plots"
}
]
"children": ["data-versioning", "data-and-model-access"]
},
{
"slug": "experiment-management",
"slug": "experiments",
"source": false,
"children": ["experiment-versioning", "experiment-management"]
},
{
"slug": "pipelines",
"source": false,
"children": ["experiments", "visualization"]
"children": ["building-pipelines", "running-pipelines"]
}
]
},
Expand Down
Loading