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

guide: reorg sidebar #4011

Merged
merged 7 commits into from
Oct 4, 2022
Merged

guide: reorg sidebar #4011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9fd5b05
guide: reorg sidebar
Sep 30, 2022
3192252
guide: update sidebar plus redirects
Oct 4, 2022
9178703
Update redirects-list.json
jorgeorpinel Oct 4, 2022
11cc513
guide: minor fixes to sidebar edits
Oct 4, 2022
650cab8
Merge branch 'ug-reorg' of github.com:iterative/dvc.org into ug-reorg
Oct 4, 2022
5e56998
guide: remove external deps/outs from pipelines
Oct 4, 2022
7d9c5f5
guide: add 302 to redirects
Oct 4, 2022
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
30 changes: 17 additions & 13 deletions content/docs/sidebar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,20 @@
}
]
},
{
"slug": "data-management",
"source": false,
"children": [
"large-dataset-optimization",
"importing-external-data",
"managing-external-data"
Comment on lines +127 to +128
Copy link
Contributor

Choose a reason for hiding this comment

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

An alternative to consider (from #144 (comment)) which may be better since we don't love the product feature as-is now (I think):

External Deps/Managing External Data: ... or make them only reachable via links.

Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

p.s. should also update the H1 in importing-external-data.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

or make them only reachable via links.

I like it better than having no solution for using data directly from the cloud, so I'm going to keep it in.

]
},
{
"slug": "pipelines",
"source": "pipelines/index.md",
"children": ["defining-pipelines"]
},
{
"label": "Experiment Management",
"slug": "experiment-management",
Expand All @@ -128,36 +142,26 @@
"running-experiments",
"hydra-composition",
"comparing-experiments",
"visualizing-plots",
Comment on lines 144 to +145
Copy link
Contributor

Choose a reason for hiding this comment

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

Possibly follow-up

Should the Parallel Coordinates Plot section be moved or linked from the Visualizing Plots page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think it should be moved since it's more related to comparing experiments, but linking could make sense.

"sharing-experiments",
"persisting-experiments",
"cleaning-experiments",
"checkpoints"
]
},
{
"slug": "pipelines",
"children": ["defining-pipelines"]
},
{
"slug": "how-to",
"source": false,
"children": [
"running-dvc-on-windows",
"setup-google-drive-remote",
"stop-tracking-data",
"update-tracked-data",
"add-deps-or-outs-to-a-stage",
"resolve-merge-conflicts",
"share-a-dvc-cache"
Comment on lines +156 to 162
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor (could be a follow-up) in terms of order and page naming:

Suggested change
"running-dvc-on-windows",
"setup-google-drive-remote",
"stop-tracking-data",
"update-tracked-data",
"add-deps-or-outs-to-a-stage",
"resolve-merge-conflicts",
"share-a-dvc-cache"
"run-dvc-on-windows",
"stop-tracking-data",
"update-tracked-data",
"resolve-merge-conflicts",
"add-deps-or-outs-to-a-stage",
"setup-google-drive-remote",
"share-a-dvc-cache"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TBH I think they're fine as is. For example, I intentionally put windows and google drive at the top since they are blockers for doing almost anything for those users.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK but (minor)

]
},
"visualizing-plots",
"setup-google-drive-remote",
"large-dataset-optimization",
"external-dependencies",
{
"label": "Managing External Data",
"slug": "managing-external-data"
},
"running-dvc-on-windows",
"troubleshooting",
{
"label": "Anonymized Usage Analytics",
Expand Down
2 changes: 1 addition & 1 deletion .../docs/user-guide/external-dependencies.md → ...ata-management/importing-external-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# External Dependencies
# Importing External Data

There are cases when data is so large, or its processing is organized in such a
way, that its preferable to avoid moving it from its current external location.
Expand Down
0 .../user-guide/large-dataset-optimization.md → ...-management/large-dataset-optimization.md
View file
Open in desktop
File renamed without changes.
0 ...docs/user-guide/managing-external-data.md → ...data-management/managing-external-data.md
View file
Open in desktop
File renamed without changes.
0 content/docs/user-guide/visualizing-plots.md → ...xperiment-management/visualizing-plots.md
View file
Open in desktop
File renamed without changes.
0 ...docs/user-guide/running-dvc-on-windows.md → ...er-guide/how-to/running-dvc-on-windows.md
View file
Open in desktop
File renamed without changes.
0 ...s/user-guide/setup-google-drive-remote.md → ...guide/how-to/setup-google-drive-remote.md
View file
Open in desktop
File renamed without changes.
6 changes: 6 additions & 0 deletions redirects-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@
"^/doc/user-guide/dvc-internals(/.*)?$ /doc/user-guide/project-structure/internal-files$1",
"^/doc/user-guide/dvcignore$ /doc/user-guide/project-structure/dvcignore-files",
"^/doc/user-guide/contributing(/.*)?$ /doc/contributing$1",
"^/doc/user-guide/large-dataset-optimization$ /doc/user-guide/data-management/large-dataset-optimization 302",
"^/doc/user-guide/external-dependencies$ /doc/user-guide/data-management/importing-external-data 302",
"^/doc/user-guide/managing-external-data$ /doc/user-guide/data-management/managing-external-data 302",
"^/doc/user-guide/running-dvc-on-windows$ /doc/user-guide/how-to/running-dvc-on-windows 302",
"^/doc/user-guide/setup-google-drive-remote$ /doc/user-guide/how-to/setup-google-drive-remote 302",
"^/doc/user-guide/visualizing-plots$ /doc/user-guide/experiment-management/visualizing-plots 302",
"^/doc/understanding-dvc(/.*)?$ /doc/user-guide/what-is-dvc",
dberenbaum marked this conversation as resolved.
Show resolved Hide resolved

"^/doc/commands-reference(/.*)?$ /doc/command-reference$1",
Expand Down