[ISSUE #783] Move FAQ docs to stable top-level path with legacy redirect#784
Merged
RongtongJin merged 1 commit intoMay 29, 2026
Merged
Conversation
RongtongJin
approved these changes
May 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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/FAQpath. The legacy/docs/bestPractice/06FAQURL 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:
[ISSUE #123] Fix UnknownException when host config not exist. Each commit in the pull request should have a meaningful subject line and body.mvn -B clean apache-rat:check findbugs:findbugs checkstyle:checkstyleto make sure basic checks pass. Runmvn clean install -DskipITsto make sure unit-test pass. Runmvn clean test-compile failsafe:integration-testto make sure integration-test pass.