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] template links broken #30905

Closed
2 tasks done
Nef10 opened this issue Feb 4, 2022 · 5 comments · Fixed by #31425
Closed
2 tasks done

[docs] template links broken #30905

Nef10 opened this issue Feb 4, 2022 · 5 comments · Fixed by #31425
Labels
docs Improvements or additions to the documentation

Comments

@Nef10
Copy link

Nef10 commented Feb 4, 2022

Duplicates

  • I have searched the existing issues

Latest version

  • I have tested the latest version

Current behavior 😯

The Source Code links on https://mui.com/getting-started/templates/ result in a 404 page.

Expected behavior 🤔

With PR #30757 the files have moved. While the path in the docs was adjusted, it is not deployed yet. It is annotated with #default-branch-switch, however the current version links to the master branch.

@Nef10 Nef10 added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Feb 4, 2022
@danilo-leal danilo-leal added docs Improvements or additions to the documentation and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Feb 4, 2022
@oliviertassinari oliviertassinari added the status: waiting for author Issue with insufficient information label Mar 12, 2022
@oliviertassinari
Copy link
Member

@Nef10 I don't get it, when I try your reproduction on a blank page, it works as expected.

@danilo-leal
Copy link
Contributor

I was being able to reproduce it normally before opening the PR (hence doing it) — maybe something's changed with the force push to publish the Survey post?!

@oliviertassinari
Copy link
Member

oliviertassinari commented Mar 12, 2022

@danilo-leal Can you still reproduce? If you can't reproduce anymore.

@oliviertassinari oliviertassinari removed the status: waiting for author Issue with insufficient information label Mar 12, 2022
@Nef10
Copy link
Author

Nef10 commented Mar 13, 2022

Hey, as I mentioned in the original bug report, the path had been adjusted in the docs, just not deployed yet. The deployment of v5.5.0 a couple of days ago fixed this problem.

Let me try to describe it again, to make it more understandable:

  1. PR [docs] Migrate content to the new location #30757 moved some files which are linked from the help page.
  2. Therefore the links obviously broke. No caching problem.
  3. While the PR also change the links in the help pages, these are only deployed when a new version is released, and not on every commit (which is the correct thing to do, but caused the bug nonetheless)
  4. The release of v5.5.0 deployed the help pages with updated links which is why the problem is fixed now.

How to prevent this?
If files linked from help pages are changed, immediately after merging a release should be done to update the help pages.

@Nef10 Nef10 closed this as completed Mar 13, 2022
@oliviertassinari
Copy link
Member

oliviertassinari commented Mar 13, 2022

#31425 should prevent this to happen again in the future. The links from the docs to GitHub are more resilient to source changes. This will also help with docs versioning.

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants