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

add r/webpack page #5196

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

chenxsan
Copy link
Member

@chenxsan chenxsan commented Jul 19, 2021

An experiment for webpack/webpack#13822 (review)

  1. from: https://webpack.js.org/r/webpack/?option=output/filename
  2. to: https://webpack.js.org/configuration/output/#outputfilename

Currently we can only make those redirections happen on client side as a single page application hosted on github pages won't support any server side redirects, i.e., urls of https://webpack.js.org/webpack-options/output/chunk-load-timeout type won't work unless we generate every intermediate page for them.

Example: https://webpack-js-org-git-fork-chenxsan-feature-ha-97c6dc-webpack-docs.vercel.app/r/webpack/?option=output/filename

@vercel
Copy link

vercel bot commented Jul 19, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/webpack-docs/webpack-js-org/A3wjw23KTAQfn2pu9HhAggc3FrTi
✅ Preview: https://webpack-js-org-git-fork-chenxsan-feature-ha-97c6dc-webpack-docs.vercel.app

@@ -12,8 +12,9 @@ export default function (location) {

if (location.pathname === '/webpack-options/') {
Copy link
Member

@alexander-akait alexander-akait Jul 19, 2021

Choose a reason for hiding this comment

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

Maybe /webpack/options/ so in future we will add /webpack-dev-server/options/ and maybe more

Copy link
Member Author

@chenxsan chenxsan Jul 19, 2021

Choose a reason for hiding this comment

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

How about https://webpack.js.org/webpack/?option=output/filename https://webpack.js.org/webpack-dev-server/?option=xxx? It's more terse.

Or https://webpack.js.org/r/webpack/?option=output/filename which is more future proof in case we will be using /webpack/ path on this site in future.

@chenxsan chenxsan changed the title add webpack-options page add webpack/options page Jul 19, 2021
@chenxsan chenxsan changed the title add webpack/options page add r/webpack page Jul 20, 2021
@chenxsan
Copy link
Member Author

chenxsan commented Jul 26, 2021

I'm afraid these's no one-size-fits-all solution as the documents don't share a common pattern.

E.g.,

  1. /configuration/module/#modulegenerator
  2. /configuration/module/#rulelayer

This pull request would work only for the first pattern. And there could be other patterns besides the aforementioned two.

Anyway we can maintain a redirect map like below on this repository:

{
  'output/filename': '/configuration/output/#outputfilename',
}

But I don't think it's a good idea, there could be hundreds of options. Generally I think we should just let users take advantage of the search function on our documentation site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants