-
Notifications
You must be signed in to change notification settings - Fork 536
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
fix(docs): Better trailing slash omission #23304
Merged
Josmithr
merged 6 commits into
microsoft:main
from
Josmithr:docs/different-trailing-slash-fix
Dec 11, 2024
Merged
fix(docs): Better trailing slash omission #23304
Josmithr
merged 6 commits into
microsoft:main
from
Josmithr:docs/different-trailing-slash-fix
Dec 11, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
base: main
PRs targeted against main branch
area: contributor experience
area: website
labels
Dec 11, 2024
alexvy86
approved these changes
Dec 11, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good thing you caught it :)
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
Merged
Josmithr
added a commit
that referenced
this pull request
Dec 12, 2024
Somehow, a formatting issue escaped our PR validation in #23304. This PR runs Biome to format that file.
Josmithr
added a commit
to Josmithr/FluidFramework
that referenced
this pull request
Dec 12, 2024
Partial reversion of microsoft#23286. SWA's implementation of `"trailingSlash": "never"` is currently flawed. The resulting redirect ends up exposing the underlying SWA URL of the site, rather than our configured front door URL. E.g. `https://fluidframework.com/docs/concepts/signals/` ends up redirecting to `https://salmon-sand-0b7fa7c1e.1.azurestaticapps.net/docs/concepts/signals`. - See Azure/static-web-apps#1036 This PR removes that configuration flag, and instead leverages Docusaurus's [trailingSlash](https://docusaurus.io/docs/api/docusaurus-config#trailingSlash) configuration option to not emit trailing slashes. This required updating a handful of relative URL links to use file path links. The guidance documentation in the README has been updated to offer new guidance around relative links in light of new learnings. [AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)
Josmithr
added a commit
to Josmithr/FluidFramework
that referenced
this pull request
Dec 12, 2024
Somehow, a formatting issue escaped our PR validation in microsoft#23304. This PR runs Biome to format that file.
Josmithr
added a commit
that referenced
this pull request
Dec 12, 2024
Reverts a change made in #23304, which ultimately results in the unwanted redirects resulting from the following SWA bug: <Azure/static-web-apps#1036>.
Josmithr
added a commit
to Josmithr/FluidFramework
that referenced
this pull request
Dec 12, 2024
Partial reversion of microsoft#23286. SWA's implementation of `"trailingSlash": "never"` is currently flawed. The resulting redirect ends up exposing the underlying SWA URL of the site, rather than our configured front door URL. E.g. `https://fluidframework.com/docs/concepts/signals/` ends up redirecting to `https://salmon-sand-0b7fa7c1e.1.azurestaticapps.net/docs/concepts/signals`. - See Azure/static-web-apps#1036 This PR removes that configuration flag, and instead leverages Docusaurus's [trailingSlash](https://docusaurus.io/docs/api/docusaurus-config#trailingSlash) configuration option to not emit trailing slashes. This required updating a handful of relative URL links to use file path links. The guidance documentation in the README has been updated to offer new guidance around relative links in light of new learnings. [AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)
Josmithr
added a commit
to Josmithr/FluidFramework
that referenced
this pull request
Dec 12, 2024
Somehow, a formatting issue escaped our PR validation in microsoft#23304. This PR runs Biome to format that file.
Josmithr
added a commit
to Josmithr/FluidFramework
that referenced
this pull request
Dec 12, 2024
Reverts a change made in microsoft#23304, which ultimately results in the unwanted redirects resulting from the following SWA bug: <Azure/static-web-apps#1036>.
Josmithr
added a commit
to Josmithr/FluidFramework
that referenced
this pull request
Dec 12, 2024
Partial reversion of microsoft#23286. SWA's implementation of `"trailingSlash": "never"` is currently flawed. The resulting redirect ends up exposing the underlying SWA URL of the site, rather than our configured front door URL. E.g. `https://fluidframework.com/docs/concepts/signals/` ends up redirecting to `https://salmon-sand-0b7fa7c1e.1.azurestaticapps.net/docs/concepts/signals`. - See Azure/static-web-apps#1036 This PR removes that configuration flag, and instead leverages Docusaurus's [trailingSlash](https://docusaurus.io/docs/api/docusaurus-config#trailingSlash) configuration option to not emit trailing slashes. This required updating a handful of relative URL links to use file path links. The guidance documentation in the README has been updated to offer new guidance around relative links in light of new learnings. [AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partial reversion of #23286.
SWA's implementation of
"trailingSlash": "never"
is currently flawed. The resulting redirect ends up exposing the underlying SWA URL of the site, rather than our configured front door URL. E.g.https://fluidframework.com/docs/concepts/signals/
ends up redirecting tohttps://salmon-sand-0b7fa7c1e.1.azurestaticapps.net/docs/concepts/signals
.trailingSlash
configuration do not recognizeX-Forwarded-Host
correctly Azure/static-web-apps#1036This PR removes that configuration flag, and instead leverages Docusaurus's trailingSlash configuration option to not emit trailing slashes.
This required updating a handful of relative URL links to use file path links. The guidance documentation in the README has been updated to offer new guidance around relative links in light of new learnings.
AB#25895