-
Notifications
You must be signed in to change notification settings - Fork 638
docs: report on storage changes and decisions. #2596
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
Conversation
I wonder whether in the report we can include a link to the branch that does migration from v1 to v2 to incentivise users to use it: https://github.com/cometbft/cometbft/blob/migrate_db/cmd/cometbft/commands/migrate_db.go . I am not sure it should be merged into main though. |
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.
love this ❤️
I think it should be in the |
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.
Left a bunch of suggestions that mainly helped improve my own understanding. Feel free to dismiss any suggestion that is unclear or incorrect.
Probably the most important thing is to add a top-level summary of Q1 results. I have left a suggestion for that also.
Two more things:
|
|
[Rendered](https://github.com/cometbft/cometbft/tree/jasmina/storage_report/docs/references/storage) Closes #1044 <!-- Please add a reference to the issue that this PR addresses and indicate which files are most critical to review. If it fully addresses a particular issue, please include "Closes #XXX" (where "XXX" is the issue number). If this PR is non-trivial/large/complex, please ensure that you have either created an issue that the team's had a chance to respond to, or had some discussion with the team prior to submitting substantial pull requests. The team can be reached via GitHub Discussions or the Cosmos Network Discord server in the #cometbft channel. GitHub Discussions is preferred over Discord as it allows us to keep track of conversations topically. https://github.com/cometbft/cometbft/discussions If the work in this PR is not aligned with the team's current priorities, please be advised that it may take some time before it is merged - especially if it has not yet been discussed with the team. See the project board for the team's current priorities: https://github.com/orgs/cometbft/projects/1 --> --- #### PR checklist - [x] Tests written/updated - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec --------- Co-authored-by: Adi Seredinschi <a@seredinschi.net> Co-authored-by: Adi Seredinschi <adizere@gmail.com> (cherry picked from commit 4fc0288)
[Rendered](https://github.com/cometbft/cometbft/tree/jasmina/storage_report/docs/references/storage) Closes #1044 --- #### PR checklist - [x] Tests written/updated - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #2596 done by [Mergify](https://mergify.com). Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com> Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
Rendered
Closes #1044
PR checklist
.changelog
(we use unclog to manage our changelog)docs/
orspec/
) and code comments