Need to modify case-sensitive URLs

[yzeng25]

Actual Behaviour

Currently, the URLs on blogs are case-sensitive, which is resulted from rules set by Apache Server. The case-sensitive URLs become inconvenient when referencing them in other websites and social media. Some might change the upper-case letters in the URLs to lower-case letters automatically. Yet visiting the low-case URLs would return a 404 page.

From the user's aspect (i.e. anyone tries to visit the URLs for the first time) would not be able to access the contents in URLs. And the user experience can be improved.

Expected Behaviour

1. input the URLs with upper-case letters, it is accessible
2. input the URLs with lower-case letters, it is also accessible

Steps to reproduce it
Take https://apisix.apache.org/blog/2021/06/28/why-we-need-Apache-APISIX/ for example:

1. Open your browser.
2. Input the URL:https://apisix.apache.org/blog/2021/06/28/why-we-need-Apache-APISIX/
3. Access the content successfully.
4. Change Apache-APISIX to lower-case apache-apisix
5. Returns 404.

Screenshots of the issue

Would you like to work on the issue?

yes

[namangirdhar16]

@juzhiyuan @yzeng25 if this issue is open, can i work on this?

[juzhiyuan]

Wow! Nice to meet you here!!

[yzeng25]

@juzhiyuan @yzeng25 if this issue is open, can i work on this?

Yes, glad to see that :)

[yzeng25]

After some researching, there are three ways that could solve this problem, but they all have certain limitations.

1. Use slug to customize he last part of the document URL, ref: https://docusaurus.io/docs/docs-introduction#document-id .
2. Rename files directly.
3. Use plugin-client-redirects to perform redirections., ref: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects

Expected Result:

1. Input the URLs with upper-case letters, it is accessible.
2. Input the URLs with lower-case letters, it is also accessible.

For Method 1, I tested it locally. The slug annotation works fine, but only 1 URL works. For example, the original suffix is /why-we-need-Apache-APISIX, and then use slug to modify it to /why-we-need-apache-apisix. Only the second one is accessible, the original one returns 404.

For Method 2, renaming files can definitely solve the problem. But we would have to find and update all of these links provided to external media, which is not an easy thing to do.

For Method 3, plugin-client-redirects requires manual maintenance and update.

[juzhiyuan]

How about this?

• For future posts, we use slug property & lowercase URLs only;
• For the current posts, we could use plugins to redirect historical URLs to lowercase.

[yzeng25]

How about this?

• For future posts, we use slug property & lowercase URLs only;
• For the current posts, we could use plugins to redirect historical URLs to lowercase.

Sure!

[juzhiyuan]

🥰🥰

[adarrssh]

@juzhiyuan is this issue open?

[juzhiyuan]

Hi @adarrssh, yes, this issue is still open because some URLs still have this problem. Would you like to try to fix them? by converting URLs from CamelCase to lowercase.

[adarrssh]

yes, I would like to work on this, please assign me this issue.

[yzeng25]

yes, I would like to work on this, please assign me this issue.

Cool! Glad to see you solving another issue!