Skip to content

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Dec 11, 2023

This is an automatic backport of pull request #1781 done by Mergify.
Cherry-pick of 9020ce2 has failed:

On branch mergify/bp/v0.38.x/pr-1781
Your branch is up to date with 'origin/v0.38.x'.

You are currently cherry-picking commit 9020ce234.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/app-dev/app-architecture.md
	modified:   docs/app-dev/getting-started.md
	modified:   docs/app-dev/indexing-transactions.md
	modified:   docs/core/metrics.md
	modified:   docs/guides/install.md
	modified:   docs/guides/quick-start.md
	modified:   docs/qa/README.md
	modified:   docs/tools/README.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   docs/app-dev/abci-cli.md
	both modified:   docs/core/validators.md
	deleted by us:   docs/data-companion/README.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

* docs: remove "Run" section from install

The "Quick Start" guide does a much better job explaining what is
happening, and readers should follow that guide instead.

* docs: move "CometBFT Quality Assurance" down

No reason to have “CometBFT Quality Assurance” as a second item. The
target audience for that document is probably security researchers - not
the primary audience.

* docs: remove cmdKVStore func in favor of link

I can’t see a single reason why users need to see the source code of
that function in order to progress with the abci-cli tool.

Also the link should point to kvstore app, not abci-cli tool!

* docs: swap abci-cli and getting-started items

https://docs.cometbft.com/v0.38/app-dev/getting-started#first-cometbft-app
should go before https://docs.cometbft.com/v0.38/app-dev/abci-cli
because the latter is used to test ABCI applications. And by this point,
the reader doesn’t have an app to test.

* docs: remove "Committing a Block" from validators page

not clear what’s the reason of explaining consensus details in the
validators section. If a validator wants to get familiar with consensus,
shouldn’t it go to consensus spec / page?

* docs: make it clear who curates the validator set

“Validators are expected to be online, and the set of validators is
permissioned/curated by some external process.” This sentence is
confusing to me. The set is curated by the ABCI application.

* docs: replace EndBlock with FinalizeBlock

* docs: add Bash script to compile persistent peers string

Getting an ID from every machine is tedious and can be streamlined with
a script, which, given IPs, collects IDs and outputs the command to run
CometBFT.

(cherry picked from commit 9020ce2)

# Conflicts:
#	docs/app-dev/abci-cli.md
#	docs/core/validators.md
#	docs/data-companion/README.md
@mergify mergify bot requested a review from a team as a code owner December 11, 2023 12:42
@mergify mergify bot added the conflicts label Dec 11, 2023
@melekes melekes merged commit 6224629 into v0.38.x Dec 11, 2023
@melekes melekes deleted the mergify/bp/v0.38.x/pr-1781 branch December 11, 2023 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant