Skip to content

[ISSUE #783] Move FAQ docs to stable top-level path with legacy redirect#784

Merged
RongtongJin merged 1 commit into
apache:new-official-websitefrom
majialoong:new-official-website
May 29, 2026
Merged

[ISSUE #783] Move FAQ docs to stable top-level path with legacy redirect#784
RongtongJin merged 1 commit into
apache:new-official-websitefrom
majialoong:new-official-website

Conversation

@majialoong

Copy link
Copy Markdown
Contributor

What is the purpose of the change

See #783

The FAQ page URL is currently tied to its location and ordering under the Best Practice docs. When the Best Practice document structure changes, the FAQ URL may change as well, which can break externally referenced links.

Since the FAQ URL may be printed by clients as user-facing guidance, it should use a stable public path.

Brief changelog

Use stable FAQ URLs to ensure that users can always access the correct page based on the URL.

Historically, /docs/faq/ has already been exposed publicly, so this PR 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/.

Verifying this change

Local test.

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a Github issue filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
  • Format the pull request title like [ISSUE #123] Fix UnknownException when host config not exist. Each commit in the pull request should have a meaningful subject line and body.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in test module.
  • Run mvn -B clean apache-rat:check findbugs:findbugs checkstyle:checkstyle to make sure basic checks pass. Run mvn clean install -DskipITs to make sure unit-test pass. Run mvn clean test-compile failsafe:integration-test to make sure integration-test pass.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

@RongtongJin RongtongJin merged commit 927d0f2 into apache:new-official-website May 29, 2026
1 check passed
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