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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6968de2
docs: update changelog
Wenjie0329 Mar 29, 2024
8f5c582
docs: update the blog
Wenjie0329 Mar 29, 2024
cc8a31c
docs: update summary structure
Wenjie0329 Mar 29, 2024
dd4e119
docs: update fie name
Wenjie0329 Mar 29, 2024
985b4a0
docs: update
Wenjie0329 Mar 29, 2024
1defe39
docs: update title
Wenjie0329 Mar 29, 2024
944ca04
doc: update file name
Wenjie0329 Mar 29, 2024
b59e257
docs: change file name
Wenjie0329 Apr 1, 2024
9021754
Merge branch 'main' into docs/update-changelog
tisonkun Apr 2, 2024
7d32bda
feat: drop roadmap, layout release notes
tisonkun Apr 2, 2024
8aafd06
docs: add release v0.7.0 notes
tisonkun Apr 2, 2024
1b5ecf1
chore: fixup links
tisonkun Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/.vitepress/config/en.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ export const enConfig = async () => ({
key: 'Changelog',
icon: 'changelog',
},
{
key: 'Release Notes',
icon: 'changelog',
},
{
key: 'FAQ and Others',
icon: 'FAQandOthers',
Expand Down
Binary file added docs/public/version-plan1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 0 additions & 53 deletions docs/v0.7/en/changelog/biweekly-reports/latest-biweekly-report.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions docs/v0.7/en/changelog/biweekly-reports/overview.md
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions docs/v0.7/en/changelog/overview.md
View file
Open in desktop

This file was deleted.

6 changes: 4 additions & 2 deletions docs/v0.7/en/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,14 @@ Before getting started, please read the following documents that include instruc
- [User Guide][2]: For application developers to use GreptimeDB or build custom integration.
- [GreptimeCloud][6]: For users of GreptimeCloud to get started.
- [Contributor Guide][3]: For contributor interested in learning more about the technical details and enhancing GreptimeDB as a contributor.
- [Changelog][4]: Presents the latest GreptimeDB roadmap and biweekly reports.
- [Roadmap][7]: The latest GreptimeDB roadmap.
- [Release Notes][4]: Presents all the historical version release notes.
- [FAQ][5]: Presents the most frequently asked questions.

[1]: ./getting-started/overview.md
[2]: ./user-guide/overview.md
[3]: ./contributor-guide/overview.md
[4]: ./changelog/overview.md
[4]: ./release-notes/all-releases.md
[5]: ./faq-and-others/faq.md
[6]: ./greptimecloud/overview.md
[7]: https://www.greptime.com/blogs/2024-02-29-greptimedb-2024-roadmap
5 changes: 5 additions & 0 deletions docs/v0.7/en/release-notes/all-releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.


## 0.7

* [0.7.0](release-0-7-0.md): 2024-03-12
Loading
Loading