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

[majialoong]

• Fixes [Bug] Fix outdated FAQ documentation URL in FAQUrl #10393

[majialoong]

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]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.93%. Comparing base (c9e51d6) to head (33cb34d).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

@@              Coverage Diff              @@
##             develop   #10394      +/-   ##
=============================================
- Coverage      49.10%   47.93%   -1.18%     
+ Complexity     13508    13252     -256     
=============================================
  Files           1376     1376              
  Lines         100537   100536       -1     
  Branches       12983    12983              
=============================================
- Hits           49368    48188    -1180     
- Misses         45175    46407    +1232     
+ Partials        5994     5941      -53     

☔ 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.

[yx9o]

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]

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

[majialoong]

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/.

[yx9o]

/docs/faq/

Would it be more reasonable to update RocketMQ to the latest FAQ URL: https://rocketmq.apache.org/docs/faq/?

On the rocketmq-site side, FAQ.md can be moved to the top-level docs path, while keeping compatibility by redirecting both /docs/bestPractice/06FAQ and /docs/bestPractice/09FAQ to /docs/faq/.

[majialoong]

/docs/faq/

Would it be more reasonable to update RocketMQ to the latest FAQ URL: https://rocketmq.apache.org/docs/faq/?

On the rocketmq-site side, FAQ.md can be moved to the top-level docs path, while keeping compatibility by redirecting both /docs/bestPractice/06FAQ and /docs/bestPractice/09FAQ to /docs/faq/.

@yx9o Here /docs/faq/ refers to the path suffix, so the full FAQ URL is https://rocketmq.apache.org/docs/faq/.

I think /docs/bestPractice/09FAQ has not been exposed publicly. The legacy URL that needs compatibility should be /docs/bestPractice/06FAQ, so only /docs/bestPractice/06FAQ needs to be redirected to /docs/faq/.

This PR apache/rocketmq-site#784 follows this approach.