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-infra] Throw on incorrect internal links #37326

Merged
merged 3 commits into from
May 23, 2023

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented May 18, 2023

Quick fixes. I have found them looking with Jan into how we can improve Algolia's experience on the docs, especially around the no search results. Its crawler reports issues (301, 404, etc.)

Screenshot 2023-05-18 at 18 22 33

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


Docs-infra change: I have added a new logic to break the CI if the link is wrong, this shouldn't go to production.

Screenshot 2023-05-19 at 15 37 22

@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work docs Improvements or additions to the documentation labels May 18, 2023
@@ -45,7 +45,7 @@ const theme = createTheme({
```

:::warning
⚠️ `vars` is a private field for [CSS theme variables](material-ui/experimental-api/css-theme-variables/overview/). It will throw an error if you try to pass a value to it:
`vars` is a private field for [CSS theme variables](/material-ui/experimental-api/css-theme-variables/overview/). It will throw an error if you try to pass a value to it:
Copy link
Member Author

@oliviertassinari oliviertassinari May 18, 2023

Choose a reason for hiding this comment

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

  1. I have removed the ⚠️ so we can normalize how warning are displayed in the docs
  2. I think that we should stop using the /overview/ pattern, / should be enough for this

@mui-bot
Copy link

mui-bot commented May 18, 2023

@oliviertassinari oliviertassinari added the scope: docs-infra Specific to the docs-infra product label May 19, 2023
@oliviertassinari oliviertassinari changed the title [docs] Fix link issues [docs] Fix incorrect links May 19, 2023
@oliviertassinari oliviertassinari changed the title [docs] Fix incorrect links [docs-infra] Crash on incorrect internal links May 19, 2023
@oliviertassinari oliviertassinari changed the title [docs-infra] Crash on incorrect internal links [docs-infra] Throw on incorrect internal links May 19, 2023
@oliviertassinari oliviertassinari merged commit a99b40a into mui:master May 23, 2023
@oliviertassinari oliviertassinari deleted the fix-link-issues branch May 23, 2023 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants