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

nav: clean up Studio nav + misc. updates #3621

Merged
merged 25 commits into from
Jul 25, 2022
Merged

nav: clean up Studio nav + misc. updates #3621

merged 25 commits into from
Jul 25, 2022

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Jun 4, 2022

In prep for large changes for MR feature

In review app: https://dvc-org-nav-studio-hv40outbutj.herokuapp.com/doc/studio

@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 4, 2022 22:15 Inactive
@jorgeorpinel jorgeorpinel requested a review from tapadipti June 4, 2022 22:22
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 4, 2022 22:22 Inactive
@jorgeorpinel jorgeorpinel marked this pull request as ready for review June 4, 2022 22:22
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 4, 2022 22:32 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 4, 2022 22:35 Inactive
@jorgeorpinel
Copy link
Contributor Author

p.s. @tapadipti is this is not useful now please close it and we'll circle back after the MR release.

@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 5, 2022 04:38 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 5, 2022 18:04 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 5, 2022 18:09 Inactive
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

@tapadipti to make your review easier if you do want to go ahead, here's a summary of the relevant changes (the Git diff looks larger than it is due to all the link updates). Thanks

content/docs/sidebar.json Show resolved Hide resolved
content/docs/studio/get-started.md Outdated Show resolved Hide resolved
content/docs/studio/get-started.md Outdated Show resolved Hide resolved
content/docs/sidebar.json Show resolved Hide resolved
content/docs/studio/user-guide/install-github-app.md Outdated Show resolved Hide resolved
redirects-list.json Outdated Show resolved Hide resolved
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-hv40outbutj June 7, 2022 07:17 Inactive
@jorgeorpinel jorgeorpinel self-assigned this Jun 18, 2022
@shcheklein
Copy link
Member

@jorgeorpinel rebase, @tapadipti could you please review?

@tapadipti
Copy link
Contributor

@jorgeorpinel I tried to review this today, but it seems I'll be replacing "views" with "projects" in many places. Shall we resolve the conflicts first? Let me know if you need me to do it.

and some link fixes
and redirect fixes
Comment on lines 85 to 96
"^/doc/studio/view-settings$ /doc/studio/user-guide/projects/project-settings",
"^/doc/studio/user-guide/explore-experiments$ /doc/studio/user-guide/projects/explore-experiments",
"^/doc/studio/user-guide/visualize-experiments$ /doc/studio/user-guide/projects/visualize-experiments",
"^/doc/studio/user-guide/run-experiments$ /doc/studio/user-guide/projects/run-experiments",

"^/doc/studio/user-guide/views/create-view$ /doc/studio/user-guide/projects/create-project",
"^/doc/studio/user-guide/views/view-settings$ /doc/studio/user-guide/projects/project-settings",
"^/doc/studio/user-guide/views/(.*)$ /doc/studio/user-guide/projects/$1",
"^/doc/studio/overview$ /doc/studio/how-it-works",
"^/doc/studio/view-settings$ /doc/studio/user-guide/views/view-settings",
"^/doc/studio/user-guide/explore-experiments$ /doc/studio/user-guide/views/explore-experiments",
"^/doc/studio/user-guide/visualize-experiments$ /doc/studio/user-guide/views/visualize-experiments",
"^/doc/studio/user-guide/run-experiments$ /doc/studio/user-guide/views/run-experiments",
"^/doc/studio/user-guide/prepare-repositories$ /doc/studio/user-guide/prepare-your-repositories",
"^/doc/studio/user-guide/views/create-view$ /doc/studio/user-guide/projects-and-experiments/create-a-project",
"^/doc/studio/user-guide/views/view-settings$ /doc/studio/user-guide/projects-and-experiments/configure-a-project",
"^/doc/studio/user-guide/views/explore-experiments$ /doc/studio/user-guide/projects-and-experiments/explore-ml-experiments",
"^/doc/studio/user-guide/views/visualize-experiments$ /doc/studio/user-guide/projects-and-experiments/visualize-and-compare",
"^/doc/studio/user-guide/views/share-view$ /doc/studio/user-guide/projects-and-experiments/share-a-projects",
"^/doc/studio/user-guide/views(/.*)?$ /doc/studio/user-guide/projects-and-experiments$1",
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Jul 18, 2022

Choose a reason for hiding this comment

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

Updated redirects (preserves previously published 301 redirects) -- also being fixed in #3772 though

Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Also need to add redirects from projects(/.*)?$ to projects-and-experiments$1, right? In case anyone has the old URLs bookmarked.
  2. For some reason, in my local set-up, http://localhost:8000/doc/studio/user-guide/ does not automatically open http://localhost:8000/doc/studio/user-guide/prepare-your-repositories. If it does for you, you can ignore this comment. If it does not, then need to figure out the issue.

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Jul 18, 2022

Choose a reason for hiding this comment

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

  1. Also need to add redirects from projects(/.*)?$ to projects-and-experiments$1, right?

They're in #3772 which we should merge first. I am hoping we can remove those intermediate redirects though, as explained in #3772 (review) (will add change here once that PR is merged).

  1. in my local set-up, http://localhost:8000/doc/studio/user-guide/ does not automatically open...

Probably a caching issue (try clearing the site data). You can try it here: https://dvc-org-nav-studio-schwvjr3pxx.herokuapp.com/doc/studio/user-guide : Gatsby does a 307 redirect. On the nav, User Guide is directly linked to /prepare-your-repositories .

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Jul 18, 2022

@tapadipti I fixed the conflicts. Due to the merge complexity some files are not recognized as moved by Git, but you can check the new redirects to see which ones are mainly renamed (some of them have H1 titles updated too).

@jorgeorpinel

This comment was marked as resolved.

@jorgeorpinel

This comment was marked as resolved.

jorgeorpinel added a commit that referenced this pull request Jul 19, 2022
* redirects: reinstate previous studio paths, fix others

* redirects: make studio UG project links 302
due to #3621

* Update redirects-list.json

* Update redirects-list.json
@jorgeorpinel jorgeorpinel removed the ⌛ status: wait-core-merge Waiting for related product PR merge/release label Jul 19, 2022
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 19, 2022 05:14 Inactive
@tapadipti
Copy link
Contributor

@jorgeorpinel Shall we merge this? It says there are conflicts to be resolved.

@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 09:23 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 09:30 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 09:38 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 18:35 Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Jul 25, 2022

Link Check Report

All 25 links passed!

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Just a couple more ref links (committing)

content/docs/studio/troubleshooting.md Outdated Show resolved Hide resolved
content/docs/studio/user-guide/teams.md Outdated Show resolved Hide resolved
content/docs/studio/user-guide/teams.md Outdated Show resolved Hide resolved
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 18:58 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 18:59 Inactive
redirects-list.json Outdated Show resolved Hide resolved
redirects-list.json Outdated Show resolved Hide resolved
@shcheklein shcheklein temporarily deployed to dvc-org-nav-studio-schwvjr3pxx July 25, 2022 19:23 Inactive
@jorgeorpinel
Copy link
Contributor Author

OK I double checked all the redirects on the review app and it looks good. All the content changes too. Merging!

@jorgeorpinel jorgeorpinel merged commit 3e36515 into main Jul 25, 2022
@jorgeorpinel jorgeorpinel deleted the nav/studio branch July 25, 2022 19:25
tapadipti added a commit that referenced this pull request Jul 26, 2022
* nav: clean up and rename files + remove UG index

* studio: misc. edits

* studio: redirects per sidebar changes

* nav: viz exps (Studio UG)

* links: changes studio URLs

* studio: remove how-it-works info from overview

* Update content/docs/studio/user-guide/prepare-your-repositories.md

* Update content/docs/studio/get-started.md

Co-authored-by: tapadipti <[email protected]>

* Update content/docs/studio/get-started.md

Co-authored-by: tapadipti <[email protected]>

* guide: better md ref link
per #3621 (comment)

* Restyled by prettier (#3775)

Co-authored-by: Restyled.io <[email protected]>

* guide: better titles for Change Team Plan and Size

* guide: GH App title

* guide: Connect GL Server title

* Update content/docs/studio/user-guide/billing-and-payment.md

* Restyled by prettier (#3777)

Co-authored-by: Restyled.io <[email protected]>

* Draft of Model Registry docs

* Deleted package-lock.json which was committed by mistake

* Further work on MR docs

* Removed unnecessary gifs

* Further work on MR docs

* Further work on MR docs

* Further work on MR docs

* Studio MR docs continued

* Apply suggestions from code review

Co-authored-by: Jorge Orpinel <[email protected]>
Co-authored-by: Jelle <[email protected]>

* Applied PR review suggestions

* Applied PR review comments

* Applied PR review comments

* Applied PR review comments

* Applied PR review comments

* Applied PR review comments

* Applied PR review comments

* Apply PR review comments

* Change promote to assign stage

* Small fixes to MR docs

* Small fixes to MR docs

* Small fixes to MR docs

* Update urls of tutorial videos

* Replaced the alert in the header to announce model registry release

* Improved troubleshooting section

* Update content/docs/studio/user-guide/model-registry/add-a-model.md

Co-authored-by: Jelle <[email protected]>

* Lint fix

* Removed TODOs

* Revert unrelated changes (wrong merge)

* Other small fixes

* Update content/docs/studio/user-guide/prepare-your-repositories.md

* Update content/docs/sidebar.json

* Restyled by prettier (#3807)

Co-authored-by: Restyled.io <[email protected]>

* Apply suggestions from code review

* Restyled by prettier (#3808)

Co-authored-by: Restyled.io <[email protected]>

* Correct MR video links

Co-authored-by: Jorge Orpinel Perez <[email protected]>
Co-authored-by: Jorge Orpinel <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Jelle <[email protected]>
@jorgeorpinel jorgeorpinel added the type: enhancement Something is not clear, small updates, improvement suggestions label Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: studio Content of /doc/studio; github.com/iterative/studio/labels/A%3A%20help%20%26%20docs%20%26%20media type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants