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

[docs] Update /base url references to /base-ui #37412

Merged
merged 18 commits into from
Jun 12, 2023

Conversation

brijeshb42
Copy link
Contributor

@brijeshb42 brijeshb42 commented May 26, 2023

Written by @mnajdova, @brijeshb42 please add something if I have missed.
Closes #36887

This changed in this PR:

  1. moved docs/pages/base to docs/pages/base-ui
  2. updated the buildApi script to generate the API & demo pages in the new location
  3. replaced all /base/* urls to /base-ui/*
  4. added redirects (replaced all end urls to point to /base-ui/* to avoid double redirection) & added general redirect from /base/* to /base-ui/*
  5. update getUrlProduct logic to not change the product name cc @siriwatknp to validate this change.

All redirects have been tested on the pull request preview.

https://deploy-preview-37412--material-ui.netlify.app/base-ui/getting-started/overview/

@brijeshb42 brijeshb42 changed the title Docs update base UI route [docs] update base UI route May 26, 2023
@brijeshb42 brijeshb42 changed the title [docs] update base UI route [docs]: Update /base url references to /base-ui May 26, 2023
@brijeshb42 brijeshb42 added the docs Improvements or additions to the documentation label May 26, 2023
@mnajdova mnajdova changed the title [docs]: Update /base url references to /base-ui [docs] Update /base url references to /base-ui May 29, 2023
@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels May 29, 2023
@mnajdova mnajdova marked this pull request as ready for review May 30, 2023 09:25
@zannager zannager requested a review from mnajdova May 30, 2023 09:42
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

LGTM, I fixed everything I could think of. Would be great if someone else can double check as I did lots of the changes :) cc @mui/core

@danilo-leal danilo-leal added the package: base-ui Specific to @mui/base label May 30, 2023
@siriwatknp
Copy link
Member

siriwatknp commented May 31, 2023

@oliviertassinari should we use ahrefs to ensure that all the changes are correct? I remember that it was really helpful when I migrated material-ui to mui.com but I can't find the account to log in to ahrefs.

Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

👍 Tested, looks good. For safety, I recommend waiting for @oliviertassinari response about using ahrefs to scan all the links of the deploy preview

@danilo-leal danilo-leal added this to the Base UI: Stable release milestone May 31, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 5, 2023
@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 5, 2023

@oliviertassinari Should we use ahrefs to ensure that all the changes are correct? I remember that it was really helpful when I migrated material-ui to mui.com but I can't find the account to log in to ahrefs.

@siriwatknp I think that https://www.screamingfrog.co.uk/seo-spider/ is already a great starting point. I did a quick run with it, it's limited to 500 URLs in the free version, and it didn't find anything.

So next: ahrefs. I have invited you to ahrefs. I have also created this shared account so I don't have to add each person: https://www.notion.so/mui-org/Accounts-945f0ccb9f7749ccb9e84b9eb9b13ec7?pvs=4#141c93115cde4f1481fbb771809b9fcd and the next time It can happen without me. The crawl is in progress: https://app.ahrefs.com/site-audit/5024581/3/overview.


I can find two problems:

Screenshot 2023-06-05 at 18 11 55

@siriwatknp
Copy link
Member

  • We will need to update Algolia's crawler, e.g.

Updated in Algolia crawler (we can remove the /base/** later for smooth transition)

image

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 6, 2023
@brijeshb42 brijeshb42 force-pushed the docs-update-base-ui-route branch 2 times, most recently from 464816d to 2a0ac5c Compare June 7, 2023 13:29
@brijeshb42 brijeshb42 force-pushed the docs-update-base-ui-route branch 2 times, most recently from 1b48a78 to 657a199 Compare June 8, 2023 15:42
@brijeshb42
Copy link
Contributor Author

@siriwatknp @oliviertassinari No issues found in ahrefs audit.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 10, 2023

Updated in Algolia crawler (we can remove the /base/** later for smooth transition)

@siriwatknp I think that it's a first good step 👍
I have also invited more @mui.com accounts to have access to the Algolia's admin panel.

Next, I think that we will need to fix the product name and ranking path to be "base-ui", not "base":

https://crawler.algolia.com/admin/crawlers/739c29c8-99ea-4945-bd27-17a1df391902/configuration/edit

The simplest way to fix this might be to move the information outside of the Algolia's crawler. IMHO, this should have been inside the the HTML page for Algolia to extra from since the beginning. It's part of the action item in #16502.

No issues found in ahrefs audit.

@brijeshb42 I can find 6 broken links (404) from https://app.ahrefs.com/site-audit/5024581/4/data-explorer?columns=pageRating%2Curl%2Ctraffic%2ChttpCode%2Cdepth%2Ccompliant%2CincomingAllLinks%2Corigin&filterId=91013c8aafad4fe1f7a0ad504eccad42&issueId=c64da643-d0f4-11e7-8ed1-001e67ed4656&sorting=-pageRating that are still left to be fixed. Ideally 200, but 301 at worst.

I can't find anything else that could be a regression.


In the future, it would be awesome to change the markdown file location to match exactly with the URL, this would allows us to have more logic that is filename location based, hence be simpler to reason with.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 11, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 12, 2023
@brijeshb42
Copy link
Contributor Author

brijeshb42 commented Jun 12, 2023

Added a fix for broken links found in ahrefs audit. I'll start the crawler again after the preview is ready to make sure the fix does not break anything else.

Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

💯 Great job! I could not detect any potential bug, thanks for working on this. The only last thing is to fix the E2E website CI.

@brijeshb42
Copy link
Contributor Author

Found 1 final issue but it's also on mui.com so I'll merge it and push a fix separately.

@brijeshb42 brijeshb42 merged commit a60988d into mui:master Jun 12, 2023
21 checks passed
@brijeshb42 brijeshb42 deleted the docs-update-base-ui-route branch June 12, 2023 10:29
@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 14, 2023

@brijeshb42 Sweet, I'm excited about this change! I have open 2 PRs to fix small issues. I can't notice anything else.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Replace mui.com/base with mui.com/base-ui
6 participants