[Site] Simplify the doc directory structure #2033
Merged
Conversation
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
flyrain
commented
Jul 11, 2025
Contributor
Author
There was a problem hiding this comment.
The git diff behavior a bit weird. This file has been moved to the parent dir.
flyrain
commented
Jul 11, 2025
site/content/in-dev/release_index.md
Outdated
Contributor
Author
There was a problem hiding this comment.
This file was never used
flyrain
requested review from
Copilot,
dimas-b,
eric-maynard,
gh-yzou and
singhpk234
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines the documentation directory by removing the old in-dev/unreleased folder and consolidation files under site/content/in-dev, and it updates links and menu entries to match the new structure.
- Update Hugo menu URL for “In Development”
- Delete obsolete
unreleasedindex and release template - Add consolidated
in-dev/_index.mdand fix related links
Reviewed Changes
Copilot reviewed 6 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| site/hugo.yaml | Changed “In Development” menu URL to point at /in-dev/ |
| site/content/in-dev/unreleased/_index.md | Deleted obsolete unreleased overview file |
| site/content/in-dev/release_index.md | Deleted unused release index template |
| site/content/in-dev/metastores.md | Updated configuration link path |
| site/content/in-dev/_index.md | Added consolidated overview with full front matter and content |
| README.md | Updated Configuration Guide link to new in-dev path |
Comments suppressed due to low confidence (2)
site/content/in-dev/metastores.md:45
- [nitpick] Consider rephrasing "please ref" to "please refer to" for clearer documentation.
Additionally the retries can be configured via `polaris.persistence.relational.jdbc.*` properties please ref [configuration](configuration.md)
README.md:107
- Verify that
site/content/in-dev/configuration.mdexists at this path; otherwise, update the link to the correct file location or site URL.
Please see the [Configuration Guide](site/content/in-dev/configuration.md) for more information.
Contributor
|
Thanks for the review ping on this, @flyrain ! Could you also point me at the current docs build/release process ? |
Contributor
Author
Here is the @snazy 's comment: #1910 (review). I think it's the right approach. The current release guide need an update. |
Contributor
Author
sfc-gh-yzou
approved these changes
Jul 11, 2025
gh-yzou
approved these changes
Jul 11, 2025
github-project-automation
bot
moved this from PRs In Progress
to Ready to merge
in Basic Kanban Board
github-project-automation
bot
moved this from Ready to merge
to Done
in Basic Kanban Board
Member
Member
|
BTW: the cite to 1910 does not say that I propose this structure. |
snazy
added a commit
to snazy/polaris
that referenced
this pull request
Jul 15, 2025
The PR apache#2033 was merged within less than 3 hours, late on a Friday. Since that change does not address an issue that seriously deserves a quick reaction nor is it a "nit", I'm proposing to revert the change. We do have [community best practices](https://polaris.apache.org/community/contributing-guidelines/) stating to give the whole community enough time to review, which did not happen. There are concerns that the PR apache#2033 will interfere with the whole effort to automate releases. Since there was no change to review and raise the concerns, I'd like to revert it to not cause any friction with that bigger effort. Revert "Fix invalid redirect from public page (apache#2041)", commit 493bc8e. Revert "[Site] Simplify the doc directory structure (apache#2033)", commit 2db2f10.
Merged
snazy
added a commit
that referenced
this pull request
Jul 15, 2025
The PR #2033 was merged within less than 3 hours, late on a Friday. Since that change does not address an issue that seriously deserves a quick reaction nor is it a "nit", I'm proposing to revert the change. We do have [community best practices](https://polaris.apache.org/community/contributing-guidelines/) stating to give the whole community enough time to review, which did not happen. There are concerns that the PR #2033 will interfere with the whole effort to automate releases. Since there was no change to review and raise the concerns, I'd like to revert it to not cause any friction with that bigger effort. Revert "Fix invalid redirect from public page (#2041)", commit 493bc8e. Revert "[Site] Simplify the doc directory structure (#2033)", commit 2db2f10.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
With all released docs in the branch
versioned-docs, we only keep thein-devin the main branch. This PR simplifies the directory structure by removing a layerunreleasedMy local test shows it works as expected.