8000 ADR-101: Backport documentation to v0.38.x-experimental by hvanz · Pull Request #1477 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

ADR-101: Backport documentation to v0.38.x-experimental #1477

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

Merged
merged 10 commits into from
Oct 16, 2023

Conversation

hvanz
Copy link
Member
@hvanz hvanz commented Oct 11, 2023

Closes #1475

Manual backport of #1307


PR checklist

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments

* initial doc structure for data companion (#1296)

* add some boilerplate content (#1296)

* add boilerplate for gRPC docs (#1296)

* adding more content for DC docs (#1296)

* added more information for pruning retain height (#1296)

* added more info to fetch data via gRPC (#1296)

* more content, some refactoring and rewrite (#1296)

* added info about latest height stream (#1296)

* removed gRPC doc for now (#1296)

* Update docs/data-companion/pruning.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/data-companion/intro.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* changes on intro based on feedback (#1296)

* better structure and content (#1296)

* added info about block and tx index pruning (#1296)

* minor addition (#1296)

* Update docs/data-companion/pruning.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/data-companion/grpc.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/data-companion/grpc.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/data-companion/pruning.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/data-companion/pruning.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

---------

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>
@hvanz hvanz added documentation Improvements or additions to documentation P:storage-optimization Priority: Give operators greater control over storage and storage optimization labels Oct 11, 2023
@hvanz hvanz added this to the 2023-Q4 milestone Oct 11, 2023
@hvanz hvanz self-assigned this Oct 11, 2023
@hvanz hvanz requested review from a team as code owners October 11, 2023 16:09
@hvanz hvanz changed the base branch from main to v0.38.x-experimental October 11, 2023 16:10
@hvanz hvanz marked this pull request as draft October 11, 2023 16:18
@hvanz hvanz marked this pull request as ready for review October 11, 2023 17:32
Copy link
Contributor
@cason cason left a comment

Choose a reason for hiding this comment

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

Some suggestions to improve the content added by this PR, not present in the original (backported) PR.

hvanz and others added 2 commits October 12, 2023 10:42
Co-authored-by: Daniel <daniel.cason@informal.systems>
Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>
@hvanz
Copy link
Member Author
hvanz commented Oct 12, 2023

Thanks @jmalicevic @cason for the suggestions!

Copy link
Contributor
@jmalicevic jmalicevic left a comment

Choose a reason for hiding this comment

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

Minor typo, LGTM.

Copy link
Contributor
@cason cason left a comment

Choose a reason for hiding this comment

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

Good.

@hvanz hvanz merged commit dfbc0c4 into v0.38.x-experimental Oct 16, 2023
@hvanz hvanz deleted the hvanz/backport-pr1307-v0.38 branch October 16, 2023 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P:storage-optimization Priority: Give operators greater control over storage and storage optimization
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

ADR-101 Backport documentation to v0.38.x
4 participants
0