Skip to content
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

Merged
merged 12 commits into from
Apr 3, 2024
Merged

docs: update changelog #862

merged 12 commits into from
Apr 3, 2024

Conversation

Wenjie0329
Copy link
Contributor

@Wenjie0329 Wenjie0329 commented Mar 29, 2024

What's Changed in this PR

Update the changelog structure.

This refers to GreptimeTeam/greptimedb#3609

Checklist

  • Please ensure that the content in summary.yml matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@Wenjie0329 Wenjie0329 requested review from a team and nicecui as code owners March 29, 2024 09:29
Copy link

cloudflare-workers-and-pages bot commented Mar 29, 2024

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1b5ecf1
Status: ✅  Deploy successful!
Preview URL: https://45aa1b24.greptime-docs.pages.dev
Branch Preview URL: https://docs-update-changelog.greptime-docs.pages.dev

View logs

Copy link
Contributor

@tisonkun tisonkun left a 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.

Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to use differnt title from the sidebar text. Currently, they are coupled.

@alili @Aganivi do you have time to implement this feature? I guess with a sidebarLabel YAML frontmatter it can be distinguished.

Copy link
Contributor

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".

Copy link
Collaborator

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.

Copy link
Contributor

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.

Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tisonkun
Copy link
Contributor

tisonkun commented Apr 3, 2024

@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.

Copy link
Collaborator

@nicecui nicecui left a 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
Copy link
Collaborator

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.

@tisonkun
Copy link
Contributor

tisonkun commented Apr 3, 2024

Merging ...

Outstanding items are not blockers. We can discuss it later.

@tisonkun tisonkun merged commit d6f1863 into main Apr 3, 2024
4 checks passed
@tisonkun tisonkun deleted the docs/update-changelog branch April 3, 2024 02:11
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.

5 participants