start: cleanup nav #3941

jorgeorpinel · 2022-09-14T02:43:29Z

In preparation for #3943

Ideally approve/merge along with #3942.

in prep for #3678

jorgeorpinel · 2022-09-14T02:46:33Z

content/docs/sidebar.json

-          {
-            "label": "Data and Model Access",
-            "slug": "access"
-          },
-          {
-            "label": "Data Pipelines",
-            "slug": "pipelines"
-          },
+          "data-and-model-access",
+          "data-pipelines",


Significantly simplifies this section of sidebar.json.

Updates 2 URL paths so they match page titles (good for SEO, best practice).

Removing source from things might break the "Edit on GitHub" links unless we update the sidebar logic to better accept them. Might not, but we need to make sure to check.

Hmmm thanks for letting me know @rogermparent. I did not know that (probably something we can improve on in the engine...) I'll reinstate the sources for now ⏳

unless we update the sidebar logic to better accept them

iterative/gatsby-theme-iterative#77

Might not, but we need to make sure to check

P.s. I did check and the button links were broken indeed (in the review app).

The button on the review app were broken because the link generated based on master/main tree. I checked by changing the path to current branch tree and it's working.

The logic is intact to link the file source using a simple string slug. And, the source field is also getting populated accordingly.

That would be the case for some of them, but the result of the logic on some nested items, for example docs/start, render the link as https://github.com/iterative/dvc.org/blob/main/content/docs/start.md where the file is actually at https://github.com/iterative/dvc.org/blob/main/content/docs/start/index.md. We can likely just make a change that assumes source-less files are at index.md and that'd be all we need to support 90+% of source-less cases.

Well I already rolled this back for now. Feel free to take it to iterative/gatsby-theme-iterative#77 😬

Okay, I checked on the rolled-back version of the preview app.

Yes, we do need to define the source for items with index.md.

jorgeorpinel · 2022-09-14T02:47:11Z

content/docs/start/index.md

-### Experiments Trail
+### Experimentation

 - [**Experiments**](/doc/start/experiments) enable exploration, iteration, and
  comparison across many ML experiments. Track your experiments with automatic


Should we call this trail something else? Maybe "Machine Learning Experimentation" ?

jorgeorpinel · 2022-09-14T02:48:29Z

redirects-list.json

-  "^/doc/start/data-versioning$                                                           /doc/start/data-and-model-versioning",
-  "^/doc/start/data-access$                                                               /doc/start/data-and-model-access",
-  "^/doc/start/data-and-model-versioning(/.*)?$                                           /doc/start/data-management$1 302",
-  "^/doc/start/data-and-model-access(/.*)?$                                               /doc/start/data-management/access$1 302",
-  "^/doc/start/data-pipelines(/.*)?$                                                      /doc/start/data-management/pipelines$1 302",
-  "^/doc/start/metrics-parameters-plots(/.*)?$                                            /doc/start/data-management/metrics-parameters-plots$1 302",
-  "^/doc/start/sharing-data-and-model-files$                                              /doc/start/data-and-model-versioning#storing-and-sharing 302",
+  "^/doc/start/data-versioning$                                                           /doc/start/data-management",
+  "^/doc/start/data-and-model-versioning(/.*)?$                                           /doc/start/data-management 302",
+  "^/doc/start/sharing-data-and-model-files$                                              /doc/start/data-management#storing-and-sharing 302",
+  "^/doc/start/data-access$                                                               /doc/start/data-management/data-and-model-access",
+  "^/doc/start/data-and-model-access(/.*)?$                                               /doc/start/data-management/data-and-model-access 302",
+  "^/doc/start/data-pipelines(/.*)?$                                                      /doc/start/data-management/data-pipelines 302",
+  "^/doc/start/metrics-parameters-plots(/.*)?$                                            /doc/start/data-management/metrics-parameters-plots 302",


Updated and simplified redirects as well (using final locations for previous 301 ones, plus fortunately many were 302s so we can change those any time).

on top of #3941

github-actions · 2022-09-14T02:56:07Z

Link Check Report

There were no links to check!

jorgeorpinel · 2022-09-14T02:56:34Z

Also, I made a separate PR to update all the links to keep this PR lean. PTAL: #3942

shcheklein · 2022-09-14T03:08:42Z

Preview link https://dvc-org-start-cleanup-d780abpa.herokuapp.com/doc (not working here for some reason)

shcheklein

Let's not mix many things at once (e.g. data pipelines - we actually go with Pipeline now, right?)

do we need to remove a few index files here?

jorgeorpinel · 2022-09-14T03:26:26Z

Preview link https://dvc-org-start-cleanup-d780abpa.herokuapp.com/doc (not working here for some reason

Something with Heroku's SSL certs proabbly. You can chose to "visit this unsafe site":

per #3941 (comment)

jorgeorpinel · 2022-09-14T03:42:49Z

Let's not mix many things at once

Sorry @shcheklein, not sure what you mean. This is a nav cleanup with 2 URL changes. Should I make a PR for each one?

e.g. data pipelines - we actually go with Pipeline now

In the User Guide yes, but in Get Started the title is already Data Pipelines, this PR just fixed the URL so it reflects that title. We can change it, but that would be a separate change IMO. Let's discuss including that in #3943 ?

jorgeorpinel · 2022-09-14T03:49:57Z

We can change it, but that would be a separate change IMO.

Or I can return the file to pipelines.md and update the title to just Pipelines as well. Either route works for me as long as they're consistent. Regardless, it's a change (perhaps larger).

Lmk please!

shcheklein · 2022-09-14T23:56:23Z

@jorgeorpinel okay, I see I got confused since it also cleanups a lot of stuff along the way ... if this doesn't break any then LGTM ;)

jorgeorpinel · 2022-09-15T07:38:27Z

I did include other closely related goals (to my mind), 3 in total. It's def. not easy to understand just from the diff which is why I left comments (1, 2, 3). Glad it's clearer now. Thanks!

* start: cleanup nav in prep for #3678 * start: update links from all docs on top of #3941

* start: cleanup nav in prep for #3678 * start: update links from all docs on top of #3941 * start: md ref links (index)

* start: cleanup nav in prep for #3678 * start: update links from all docs on top of #3941 * start: md ref links (index) * start: make data versioning page * start: write new intro DM page and move the rest to the new DV page (old DM content) per #3955 (comment)

* start: cleanup nav in prep for #3678 * start: update links from all docs on top of #3941 * start: md ref links (index) * start: make data versioning page * start: write new intro DM page and move the rest to the new DV page (old DM content) per #3955 (comment) * start: update links from DM index to new DV page

jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start labels Sep 14, 2022

shcheklein temporarily deployed to dvc-org-start-cleanup-d780abpa September 14, 2022 02:43 Inactive

start: cleanup nav

d20cae5

in prep for #3678

jorgeorpinel force-pushed the start/cleanup branch from 95f790d to d20cae5 Compare September 14, 2022 02:45

shcheklein temporarily deployed to dvc-org-start-cleanup-d780abpa September 14, 2022 02:45 Inactive

jorgeorpinel commented Sep 14, 2022

View reviewed changes

jorgeorpinel requested review from dberenbaum and shcheklein September 14, 2022 02:49

jorgeorpinel added a commit that referenced this pull request Sep 14, 2022

start: update links from all docs

28c5cc4

on top of #3941

jorgeorpinel mentioned this pull request Sep 14, 2022

start: update links from all docs #3942

Merged

1 task

shcheklein requested changes Sep 14, 2022

View reviewed changes

jorgeorpinel mentioned this pull request Sep 14, 2022

start: clean up index page #3943

Merged

1 task

reinstate sidebar.json sources

869e597

per #3941 (comment)

shcheklein deployed to dvc-org-start-cleanup-d780abpa September 14, 2022 03:33 View deployment

jorgeorpinel mentioned this pull request Sep 14, 2022

sidebar: better support index-like sources iterative/gatsby-theme-iterative#77

Open

jorgeorpinel requested a review from shcheklein September 14, 2022 03:50

shcheklein approved these changes Sep 14, 2022

View reviewed changes

Merge branch 'main' into start/cleanup

ec18962

shcheklein temporarily deployed to dvc-org-start-cleanup-d780abpa September 15, 2022 07:34 Inactive

jorgeorpinel merged commit e8e4949 into main Sep 15, 2022

jorgeorpinel deleted the start/cleanup branch September 15, 2022 07:39

jorgeorpinel added a commit that referenced this pull request Sep 15, 2022

start: update links from all docs (#3942)

e6b2017

* start: cleanup nav in prep for #3678 * start: update links from all docs on top of #3941

jorgeorpinel added a commit that referenced this pull request Sep 15, 2022

start: clean up pages (index) (#3943)

e8e36c0

* start: cleanup nav in prep for #3678 * start: update links from all docs on top of #3941 * start: md ref links (index)

jorgeorpinel added the type: enhancement Something is not clear, small updates, improvement suggestions label Nov 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

start: cleanup nav #3941

start: cleanup nav #3941

jorgeorpinel commented Sep 14, 2022 •

edited

Loading

jorgeorpinel Sep 14, 2022 •

edited

Loading

rogermparent Sep 14, 2022

jorgeorpinel Sep 14, 2022

jorgeorpinel Sep 14, 2022

yathomasi Sep 14, 2022

rogermparent Sep 14, 2022 •

edited

Loading

jorgeorpinel Sep 14, 2022

yathomasi Sep 14, 2022

jorgeorpinel Sep 14, 2022 •

edited

Loading

jorgeorpinel Sep 14, 2022

github-actions bot commented Sep 14, 2022

jorgeorpinel commented Sep 14, 2022

shcheklein commented Sep 14, 2022

shcheklein left a comment

jorgeorpinel commented Sep 14, 2022 •

edited

Loading

jorgeorpinel commented Sep 14, 2022 •

edited

Loading

jorgeorpinel commented Sep 14, 2022

shcheklein commented Sep 14, 2022

jorgeorpinel commented Sep 15, 2022 •

edited

Loading

start: cleanup nav #3941

start: cleanup nav #3941

Conversation

jorgeorpinel commented Sep 14, 2022 • edited Loading

jorgeorpinel Sep 14, 2022 • edited Loading

Choose a reason for hiding this comment

rogermparent Sep 14, 2022

Choose a reason for hiding this comment

jorgeorpinel Sep 14, 2022

Choose a reason for hiding this comment

jorgeorpinel Sep 14, 2022

Choose a reason for hiding this comment

yathomasi Sep 14, 2022

Choose a reason for hiding this comment

rogermparent Sep 14, 2022 • edited Loading

Choose a reason for hiding this comment

jorgeorpinel Sep 14, 2022

Choose a reason for hiding this comment

yathomasi Sep 14, 2022

Choose a reason for hiding this comment

jorgeorpinel Sep 14, 2022 • edited Loading

Choose a reason for hiding this comment

jorgeorpinel Sep 14, 2022

Choose a reason for hiding this comment

github-actions bot commented Sep 14, 2022

Link Check Report

jorgeorpinel commented Sep 14, 2022

shcheklein commented Sep 14, 2022

shcheklein left a comment

Choose a reason for hiding this comment

jorgeorpinel commented Sep 14, 2022 • edited Loading

jorgeorpinel commented Sep 14, 2022 • edited Loading

jorgeorpinel commented Sep 14, 2022

shcheklein commented Sep 14, 2022

jorgeorpinel commented Sep 15, 2022 • edited Loading

jorgeorpinel commented Sep 14, 2022 •

edited

Loading

jorgeorpinel Sep 14, 2022 •

edited

Loading

rogermparent Sep 14, 2022 •

edited

Loading

jorgeorpinel Sep 14, 2022 •

edited

Loading

jorgeorpinel commented Sep 14, 2022 •

edited

Loading

jorgeorpinel commented Sep 14, 2022 •

edited

Loading

jorgeorpinel commented Sep 15, 2022 •

edited

Loading