Update release-guide.md about publishing docs #2035
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the release guide to add a dedicated “Publishing docs” section and clean up the ordering of the announcement steps, as well as moves the GitHub release link immediately after tagging.
- Introduce a new “Publishing docs” section with steps to file PRs for
versioned-docsandmain - Reorder and simplify the “Announcing the release” section
- Add the GitHub release link right after the tagging step
Comments suppressed due to low confidence (2)
site/content/release-guide.md:374
- Format this step as part of a list (e.g., prefix with '-' or a number) so it aligns with the surrounding instructions and renders consistently.
Update GitHub with the release: https://github.com/apache/polaris/releases/tag/apache-polaris-x.y.z
site/content/release-guide.md:381
- Use four spaces for nested list indentation under the ordered list so that Markdown renders these as sub-items correctly.
- Add download links and release notes in [Download page](https://github.com/apache/polaris/blob/main/site/content/downloads/_index.md)
flyrain
commented
Jul 11, 2025
| ``` | ||
| git tag -a apache-polaris-x.y.z apache-polaris-x.y.z-rci | ||
| ``` | ||
| Update GitHub with the release: https://github.com/apache/polaris/releases/tag/apache-polaris-x.y.z |
There was a problem hiding this comment.
Aggregate github action here
sfc-gh-yzou
approved these changes
Jul 11, 2025
site/content/release-guide.md
Outdated
|
|
||
| ### Announcing the release | ||
| ### Publishing docs | ||
| 1. File a PR against branch `versioned-docs` to publish the documentation |
There was a problem hiding this comment.
can we add a link for branch versioned-docs?
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
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.
No description provided.