-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update changelog #862
Conversation
Deploying greptime-docs with Cloudflare Pages
|
Signed-off-by: tison <[email protected]>
Signed-off-by: tison <[email protected]>
Signed-off-by: tison <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. @fengjiachun Please review the new release notes and see if it needs some revisions.
We'd perhaps use git-cliff and write proper commit message to automate this procedure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The release note file.
@@ -0,0 +1,5 @@ | |||
# All releases |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For example, the sidebar label of this page should be "All releases", but for page title, I'd prefer "GreptimeDB Release Notes".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is a little strange that the navigation title is different with the page title.
Cloud you please explain why do you want this feature? Is there any advantage? Maybe we can use “Release Notes” in both the navigation title and the page title.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"All Releases" may be good, but "v0.7.0" can be better as "GreptimeDB v0.7.0 Release Notes" as its title.
Take https://docs.pingcap.com/tidb/stable/release-7.5.1 as an example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@nicecui Please take a look if this structure fits your expectation. @fengjiachun @Wenjie0329 I'll compile and send a draft of RELEASE.md today. And after we come back from the holiday, we can ask one of our core developers to run for v0.7.1 so that the process is verified. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new structure is LGTM 👍
@@ -0,0 +1,5 @@ | |||
# All releases |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is a little strange that the navigation title is different with the page title.
Cloud you please explain why do you want this feature? Is there any advantage? Maybe we can use “Release Notes” in both the navigation title and the page title.
Merging ... Outstanding items are not blockers. We can discuss it later. |
What's Changed in this PR
Update the changelog structure.
This refers to GreptimeTeam/greptimedb#3609
Checklist
summary.yml
matches the current document structure when you changed the document structure.