fix(docs): Configure SWA to never emit trailing slashes for website URLs #23286

Josmithr · 2024-12-10T21:55:53Z

Ensures consistent relative file path link behavior by ensuring resolved site URLs never include a trailing slash. See https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#never

Also makes some small fixes to config files for local development.

AB#25895

Josmithr · 2024-12-11T01:34:04Z

docs/package.json

@@ -40,7 +40,7 @@
 		"prettier:fix": "prettier --write . --cache --ignore-path ../.prettierignore",
 		"rebuild": "npm run clean && npm run build",
 		"serve": "docusaurus serve",
-		"serve-with-azure-emulation": "swa start",
+		"serve-with-azure-emulation": "swa start --config-name ff-doc-site",


Unclear from the CLI docs what the policy is for a config file with only a single "configuration" entry, but this makes things more explicit.

Josmithr · 2024-12-11T01:35:09Z

docs/static/staticwebapp.config.json

@@ -14,5 +14,6 @@
 			"route": "/404",
 			"statusCode": 404
 		}
-	]
+	],
+	"trailingSlash": "never"


The crux of the "fix" - configures SWA to never emit a trailing slash in URLs.

docs/swa-cli.config.json

github-actions · 2024-12-11T01:44:15Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170006 links
    1595 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors

alexvy86

🚀

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 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)

…RLs (microsoft#23286) Ensures consistent relative file path link behavior by ensuring resolved site URLs never include a trailing slash. See <https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#never> Also makes some small fixes to config files for local development. [AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)

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)

…RLs (microsoft#23286) Ensures consistent relative file path link behavior by ensuring resolved site URLs never include a trailing slash. See <https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#never> Also makes some small fixes to config files for local development. [AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)

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)

…RLs (microsoft#23286) Ensures consistent relative file path link behavior by ensuring resolved site URLs never include a trailing slash. See <https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#never> Also makes some small fixes to config files for local development. [AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)

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 3 commits December 10, 2024 21:52

fix: Never emit trailing slash

5a5d072

fix: Script

3047b36

fix: Config

0f89943

github-actions bot added area: website base: main PRs targeted against main branch labels Dec 10, 2024

Josmithr commented Dec 11, 2024

View reviewed changes

docs/swa-cli.config.json Outdated Show resolved Hide resolved

revert: Unwanted change

21e37ab

Josmithr requested a review from a team December 11, 2024 01:36

Josmithr marked this pull request as ready for review December 11, 2024 01:36

alexvy86 approved these changes Dec 11, 2024

View reviewed changes

Josmithr merged commit cecb995 into microsoft:main Dec 11, 2024
31 checks passed

Josmithr deleted the docs/trailing-slashes branch December 11, 2024 18:06

Josmithr mentioned this pull request Dec 11, 2024

fix(docs): Better trailing slash omission #23304

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): Configure SWA to never emit trailing slashes for website URLs #23286

fix(docs): Configure SWA to never emit trailing slashes for website URLs #23286

Josmithr commented Dec 10, 2024 •

edited

Loading

Josmithr Dec 11, 2024

Josmithr Dec 11, 2024

github-actions bot commented Dec 11, 2024

alexvy86 left a comment

fix(docs): Configure SWA to never emit trailing slashes for website URLs #23286

fix(docs): Configure SWA to never emit trailing slashes for website URLs #23286

Conversation

Josmithr commented Dec 10, 2024 • edited Loading

Josmithr Dec 11, 2024

Choose a reason for hiding this comment

Josmithr Dec 11, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 11, 2024

linkcheck output

alexvy86 left a comment

Choose a reason for hiding this comment

Josmithr commented Dec 10, 2024 •

edited

Loading