Skip to content

[ISSUE #10393] Fix outdated FAQ documentation URL in FAQUrl#10394

Open
majialoong wants to merge 1 commit into
apache:developfrom
majialoong:ISSUE-10393
Open

[ISSUE #10393] Fix outdated FAQ documentation URL in FAQUrl#10394
majialoong wants to merge 1 commit into
apache:developfrom
majialoong:ISSUE-10393

Conversation

@majialoong
Copy link
Copy Markdown
Contributor

@majialoong
Copy link
Copy Markdown
Contributor Author

This PR only provides a temporary fix by updating the FAQ URL to the current correct path. However, the URL may still become unstable again if the documentation structure changes in the future.

Ideally, the official website should provide a dedicated navigation entry or stable permalink for the FAQ page, so the FAQ URL can remain consistent over time.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.89%. Comparing base (c9e51d6) to head (cc87d7e).

Additional details and impacted files
@@              Coverage Diff              @@
##             develop   #10394      +/-   ##
=============================================
- Coverage      48.96%   48.89%   -0.07%     
+ Complexity     13469    13458      -11     
=============================================
  Files           1376     1376              
  Lines         100537   100537              
  Branches       12983    12983              
=============================================
- Hits           49228    49160      -68     
- Misses         45302    45360      +58     
- Partials        6007     6017      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@majialoong majialoong changed the title [ISSUE #10201] Fix outdated FAQ documentation URL in FAQUrl [ISSUE #10393] Fix outdated FAQ documentation URL in FAQUrl May 27, 2026
@yx9o
Copy link
Copy Markdown
Contributor

yx9o commented May 28, 2026

I suggest making the FAQ a top-level docs page instead of tying it to the Best Practice ordering. We can move it to FAQ.md, keep it at the end of the root docs sidebar with sidebar_position, and use /docs/FAQ as the stable URL.

@majialoong
Copy link
Copy Markdown
Contributor Author

I suggest making the FAQ a top-level docs page instead of tying it to the Best Practice ordering. We can move it to FAQ.md, keep it at the end of the root docs sidebar with sidebar_position, and use /docs/FAQ as the stable URL.

I think this is a reasonable approach.

I have verified the feasibility of this solution locally and will submit a PR to implement this change.

On my local environment, the FAQ URL is fixed at: http://127.0.0.1:3000/docs/FAQ

image

@majialoong
Copy link
Copy Markdown
Contributor Author

I opened a PR apache/rocketmq-site#784 to make the FAQ URL stable.

@yx9o @RongtongJin @f1amingo Could you please take a look when you have time? Thanks!

Historically, /docs/faq/ has already been exposed publicly, so uses it as the fixed FAQ URL instead of introducing a new /docs/FAQ path. The legacy /docs/bestPractice/06FAQ URL is kept as a redirect to /docs/faq/.

If the other PR apache/rocketmq-site#784 is merged, this PR will also be updated to use /docs/faq/.

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.

[Bug] Fix outdated FAQ documentation URL in FAQUrl

5 participants