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: Set redirection from old links to new links after Docs overhaul #1757

Closed
juanmaguitar opened this issue Sep 12, 2024 · 3 comments
Closed
Assignees
Labels
[Type] Documentation Improvements or additions to documentation

Comments

@juanmaguitar
Copy link
Collaborator

juanmaguitar commented Sep 12, 2024

As per @ashfame and @adamziel heads up, there are some google indexed links that return a 404 error since their url has changed

some google indexed links for docs site are broken since their url has changed. Eg: https://wordpress.github.io/wordpress-playground/architecture/browser-scopes/ is 404 since page has moved over to https://wordpress.github.io/wordpress-playground/developers/architecture/browser-scopes/

This is due to the overhaul work done on #1602

The current implementation of Docusaurus (the docs engine behind WP Playground Docs) provides a system to redirect links

The following redirections need to be set for the Google-indexed links to work:

See full list of links to redirect
/apis-overview → /developers/apis/
/architecture/browser-concepts → /developers/architecture/browser-concepts
/architecture/browser-cross-process-communication → /developers/architecture/browser-cross-process-communication
/architecture/browser-iframe-rendering → /developers/architecture/browser-iframe-rendering
/architecture/browser-php-worker-threads → /developers/architecture/browser-php-worker-threads
/architecture/browser-scopes → /developers/architecture/browser-scopes
/architecture/browser-service-workers → /developers/architecture/browser-service-workers
/architecture/browser-tab-orchestrates-execution → /developers/architecture/browser-tab-orchestrates-execution
/architecture/browser-wordpress → /developers/architecture/browser-wordpress
/architecture/host-your-own-playground → /developers/architecture/host-your-own-playground
/architecture/index → /developers/architecture/index
/blueprints-api/index → /blueprints
/contributing/index → /contributing
/javascript-api/index → /developers/apis/javascript-api
/architecture/wasm-asyncify → /developers/architecture/wasm-asyncify
/architecture/wasm-php-compiling → /developers/architecture/wasm-php-compiling
/architecture/wasm-php-data-dependencies → /developers/architecture/wasm-php-data-dependencies
/architecture/wasm-php-filesystem → /developers/architecture/wasm-php-filesystem
/architecture/wasm-php-javascript-module → /developers/architecture/wasm-php-javascript-module
/architecture/wasm-php-overview → /developers/architecture/wasm-php-overview
/architecture/wordpress → /developers/architecture/wordpress
/architecture/wordpress-database → /developers/architecture/wordpress-database
/blueprints-api/blueprint-101/ → /blueprints/tutorial/
/blueprints-api/blueprint-101/build-your-first-blueprint → /blueprints/tutorial/build-your-first-blueprint
/blueprints-api/blueprint-101/how-to-load-run-blueprints → /blueprints/tutorial/how-to-load-run-blueprints
/blueprints-api/blueprint-101/troubleshoot-debug-blueprints → /blueprints/troubleshoot-and-debug-blueprints
/blueprints-api/blueprint-101/what-are-blueprints-what-you-can-do-with-them → /blueprints/tutorial/what-are-blueprints-what-you-can-do-with-them
/blueprints-api/data-format → /blueprints/data-format
/blueprints-api/examples → /blueprints/examples
/blueprints-api/json-api-and-function-api → /blueprints/steps/api-consistency
/blueprints-api/resources → /blueprints/steps/resources
/blueprints-api/steps → /blueprints/steps
/blueprints-api/steps-shorthands → /blueprints/steps/shorthands
/blueprints-api/troubleshoot-and-debug-blueprints → /blueprints/troubleshoot-and-debug-blueprints
/blueprints-api/using-blueprints → /blueprints/using-blueprints
/build-your-first-app → /developers/build-your-first-app
/javascript-api/blueprint-functions-in-api-client → /developers/apis/javascript-api/blueprint-functions-in-api-client
/javascript-api/blueprint-json-in-api-client → /developers/apis/javascript-api/blueprint-json-in-api-client
/javascript-api/index-html-vs-remote-html → /developers/apis/javascript-api/-html-vs-remote-html
/javascript-api/mount-data → /developers/apis/javascript-api/mount-data
/javascript-api/playground-api-client → /developers/apis/javascript-api/playground-api-client
/limitations → /developers/limitations
/links-and-resources → /resources
/local-development/php-wasm-node → /developers/local-development/php-wasm-node
/local-development/vscode-extension → /developers/local-development/vscode-extension
/local-development/wp-now → /developers/local-development/wp-now
/overview → /about
/playground-apis/api-concepts → /developers/apis/
/query-api → /developers/apis/query-api
/start-using → /quick-start-guide
/wordcamp-contributor-day → /contributing/contributor-day
@juanmaguitar juanmaguitar self-assigned this Sep 12, 2024
@juanmaguitar juanmaguitar added the [Type] Documentation Improvements or additions to documentation label Sep 12, 2024
@juanmaguitar
Copy link
Collaborator Author

For future reference, a sitemap with links of current pages of the Docs site is available at
https://wordpress.github.io/wordpress-playground/sitemap.xml

To get an older version of this sitemap with links of pages of the Docs site at a past time we can do

  • Checkout to an older commit with the structure of the docs we are interested in
  • npm run build
  • At dist/docs/build/sitemap.xml we'll have the sitemap with the relation of links

juanmaguitar added a commit that referenced this issue Sep 12, 2024
@brandonpayton
Copy link
Member

Hi @juanmaguitar, thanks for #1758. 🙇 Can this issue now be closed?

@brandonpayton brandonpayton moved this from Inbox to Needs Author's Reply in Playground Board Sep 12, 2024
@juanmaguitar
Copy link
Collaborator Author

Can this issue now be closed?

Yes! Closing this issue as per #1758

@github-project-automation github-project-automation bot moved this from Needs Author's Reply to Done in Playground Board Sep 13, 2024
@adamziel adamziel moved this from Done to Inbox in Playground Board Sep 13, 2024
@bgrgicak bgrgicak moved this from Inbox to Done in Playground Board Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants