v0.34.x: Rename Tendermint to CometBFT in /docs (backport #197) by mergify[bot] · Pull Request #251 · cometbft/cometbft

mergify · 2023-02-01T12:01:53Z

This is an automatic backport of pull request #197 done by Mergify.
Cherry-pick of 9883814 has failed:

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

You are currently cherry-picking commit 98838143f.
  (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/.vuepress/config.js
	deleted:    docs/.vuepress/public/logo-bw.svg
	deleted:    docs/DEV_SESSIONS.md
	renamed:    docs/app-dev/readme.md -> docs/app-dev/README.md
	renamed:    docs/imgs/bifurcation-point.png -> docs/architecture/img/bifurcation-point.png
	renamed:    docs/imgs/evidence_lifecycle.png -> docs/architecture/img/evidence_lifecycle.png
	renamed:    docs/imgs/light-client-detector.png -> docs/architecture/img/light-client-detector.png
	renamed:    docs/imgs/tm-amnesia-attack.png -> docs/architecture/img/tm-amnesia-attack.png
	renamed:    docs/tendermint-core/README.md -> docs/core/README.md
	renamed:    docs/tendermint-core/configuration.md -> docs/core/configuration.md
	renamed:    docs/tendermint-core/light-client.md -> docs/core/light-client.md
	renamed:    docs/tendermint-core/mempool.md -> docs/core/mempool.md
	renamed:    docs/tendermint-core/metrics.md -> docs/core/metrics.md
	new file:   docs/core/rpc.md
	renamed:    docs/tendermint-core/state-sync.md -> docs/core/state-sync.md
	renamed:    docs/tendermint-core/validators.md -> docs/core/validators.md
	deleted:    docs/imgs/contributing.png
	deleted:    docs/imgs/cosmos-tendermint-stack-4k.jpg
	renamed:    docs/tendermint-core/sentry_layout.png -> docs/imgs/sentry_layout.png
	renamed:    docs/tendermint-core/local_config.png -> docs/imgs/sentry_local_config.png
	deleted:    docs/imgs/tcp-window.png
	deleted:    docs/imgs/tm-application-example.png
	deleted:    docs/imgs/tm-transaction-flow.png
	deleted:    docs/imgs/tmint-logo-blue.png
	modified:   docs/introduction/README.md
	modified:   docs/introduction/install.md
	modified:   docs/introduction/quick-start.md
	deleted:    docs/introduction/what-is-tendermint.md
	modified:   docs/networks/README.md
	modified:   docs/networks/docker-compose.md
	modified:   docs/package.json
	modified:   docs/qa/README.md
	modified:   docs/qa/method.md
	modified:   docs/qa/v034/README.md
	deleted:    docs/tendermint-core-image.jpg
	deleted:    docs/tendermint-core/block-structure.md
	deleted:    docs/tendermint-core/fast-sync.md
	deleted:    docs/tendermint-core/how-to-read-logs.md
	deleted:    docs/tendermint-core/running-in-production.md
	deleted:    docs/tendermint-core/subscription.md
	deleted:    docs/tendermint-core/using-tendermint.md
	modified:   docs/tools/README.md
	new file:   docs/tutorials/README.md
	deleted:    docs/tutorials/readme.md
	modified:   spec/p2p/v0.34/README.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   docs/.vuepress/redirects
	both modified:   docs/DOCS_README.md
	both modified:   docs/README.md
	both modified:   docs/app-dev/abci-cli.md
	both modified:   docs/app-dev/app-architecture.md
	both modified:   docs/app-dev/getting-started.md
	both modified:   docs/app-dev/indexing-transactions.md
	deleted by us:   docs/architecture/README.md
	deleted by us:   docs/architecture/adr-047-handling-evidence-from-light-client.md
	deleted by us:   docs/architecture/adr-056-light-client-amnesia-attacks.md
	deleted by us:   docs/architecture/adr-059-evidence-composition-and-lifecycle.md
	deleted by us:   docs/architecture/adr-template.md
	both modified:   docs/core/block-structure.md
	added by them:   docs/core/block-sync.md
	added by us:     docs/core/fast-sync.md
	both modified:   docs/core/how-to-read-logs.md
	both modified:   docs/core/running-in-production.md
	both modified:   docs/core/subscription.md
	both modified:   docs/core/using-cometbft.md
	deleted by them: docs/introduction/architecture.md
	both modified:   docs/introduction/what-is-cometbft.md
	deleted by us:   docs/qa/v037/README.md
	deleted by us:   docs/rfc/README.md
	both deleted:    docs/tendermint-core/block-sync.md
	deleted by them: docs/tendermint-core/rpc.md
	both modified:   docs/tools/debugging.md
	both modified:   docs/tutorials/go-built-in.md
	both modified:   docs/tutorials/go.md
	both modified:   spec/consensus/consensus.md
	both modified:   spec/consensus/wal.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/rename: simple github.com links renaming * docs/rename: old links to spec repo replaced * docs/rename: Go doc links renamed, currently broken * docs/rename: fixing broken links, proper branches * docs/rename: docs.tendermint.com -> docs.cometbft.com * docs/rename: fixing front matter in .md files * docs/rename: renaming in what is tendermint page * Tendermint in a Nutshell image removed * docs/rename: cleaning, renaming docs introduction * docs/rename: renaming in docs/app-dev/ dir * docs/rename: links to main branch in docs/networks * docs/rename: renaming in docs/tools/ dir * docs/rename: renaming in docs/tutorials dir * docs/rename: moving images to docs/imgs/ dir * docs/rename: renaming in docs/tendermint-core/ dir * docs/rename: docs/tendermint-core/ -> docs/core/ * docs/rename: renaming in docs/qa/ sub path * docs/rename: renaming in .vuepress dir, logo removed * docs/rename: renaming in READMEs * docs/rename: removing Tendermint images and content * docs/rename: removing references to removed diagram * docs/rename: renaming in READMEs for RFCs and ADRs * rename: links to docs/tendermint-core -> docs/core * docs/rename: removing unused images from docs/imgs/ * docs/rename: cleaning of docs/imgs/, ADR images moved * Apply suggestions from code review Co-authored-by: Thane Thomson <connect@thanethomson.com> * Apply suggestions from code review Co-authored-by: Thane Thomson <connect@thanethomson.com> * docs/rename: removing outdated Testnets section Co-authored-by: Thane Thomson <connect@thanethomson.com> * docs/rename: removing reference to tendermint/awesome repo Co-authored-by: Thane Thomson <connect@thanethomson.com> * docs/rename: contributing section updated Co-authored-by: Thane Thomson <connect@thanethomson.com> --------- Co-authored-by: Thane Thomson <connect@thanethomson.com> (cherry picked from commit 9883814) # Conflicts: # docs/.vuepress/redirects # docs/DOCS_README.md # docs/README.md # docs/app-dev/abci-cli.md # docs/app-dev/app-architecture.md # docs/app-dev/getting-started.md # docs/app-dev/indexing-transactions.md # docs/architecture/README.md # docs/architecture/adr-047-handling-evidence-from-light-client.md # docs/architecture/adr-056-light-client-amnesia-attacks.md # docs/architecture/adr-059-evidence-composition-and-lifecycle.md # docs/architecture/adr-template.md # docs/core/block-structure.md # docs/core/block-sync.md # docs/core/fast-sync.md # docs/core/how-to-read-logs.md # docs/core/running-in-production.md # docs/core/subscription.md # docs/core/using-cometbft.md # docs/introduction/architecture.md # docs/introduction/what-is-cometbft.md # docs/qa/v037/README.md # docs/rfc/README.md # docs/tendermint-core/block-sync.md # docs/tendermint-core/rpc.md # docs/tools/debugging.md # docs/tutorials/go-built-in.md # docs/tutorials/go.md # spec/consensus/consensus.md # spec/consensus/wal.md

cason · 2023-02-01T15:10:02Z

docs/app-dev/getting-started.md

 Try some other transactions and queries to make sure everything is
 working!
-
-## Counter - Another Example


This second example was removed from main. Should we maintain it in this branch?

cason · 2023-02-01T15:10:18Z

docs/app-dev/abci-cli.md

+You could put the commands in a file and run
 `abci-cli --verbose batch < myfile`.

-## Counter - Another Example


This second example was removed from main. Should we maintain it in this branch?

docs/.vuepress/config.js

docs/README.md

docs/app-dev/abci-cli.md

docs/app-dev/app-architecture.md

docs/core/using-cometbft.md

jmalicevic · 2023-02-06T15:43:02Z

docs/core/using-cometbft.md

-        - `max_num`: This sets the maximum number of evidence that can be committed
-      in a single block. and should fall comfortably under the max block
-      bytes when we consider the size of each evidence.
+        - `max_bytes`: This sets the maximum size in bytes of evidence that can be committed


is this also renamed in the code?

max_bytes is on ./proto/tendermint/types/params.pb.go, max_num is not.

jmalicevic · 2023-02-06T15:43:21Z

docs/core/using-cometbft.md

      "max_age_num_blocks": "100000",
      "max_age_duration": "172800000000000",
-      "max_num": 50,
+      "max_bytes": 51200,


Again, double check whether it is actually renamed in the code.

jmalicevic · 2023-02-06T15:46:52Z

docs/qa/method.md

 _200 Node Test_, and _Rotating Nodes Test_.

-[releases]: https://github.com/tendermint/tendermint/blob/v0.37.x/RELEASES.md#large-scale-testnets
+[releases]: https://github.com/cometbft/cometbft/blob/main/RELEASES.md#large-scale-testnets


Suggested change

[releases]: https://github.com/cometbft/cometbft/blob/main/RELEASES.md#large-scale-testnets

[releases]: https://github.com/cometbft/cometbft/blob/v0.34.x/RELEASES.md#large-scale-testnets

?

The file doesn't exist in branch v0.34.x...

docs/tutorials/go-built-in.md

jmalicevic · 2023-02-06T15:51:56Z

docs/tutorials/go-built-in.md


-	key, value := parts[0], parts[1]
-
-	// check if the same key=value already exists


Is this removed in the code too?

The new version of the tutorial doesn't include this more comprehensive check...

But which code are you referring to?

Sorry, I thought this was actually written as some example somewhere in the code as well. My bad.

docs/tutorials/go-built-in.md

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

docs/tutorials/go-built-in.md

docs/tutorials/go.md

jmalicevic · 2023-02-06T21:45:46Z

docs/tutorials/go.md

-For the underlying key-value store we'll use
-[badger](https://github.com/dgraph-io/badger), which is an embeddable,
-persistent and fast key-value (KV) database.
+Finally, make sure to add the bytes package to the `import` stanza at the top of `app.go`:


Suggested change

Finally, make sure to add the bytes package to the `import` stanza at the top of `app.go`:

Finally, make sure to add the bytes package to the `import` statement at the top of `app.go`:

?

docs/tutorials/go.md

docs/tutorials/go-built-in.md

jmalicevic · 2023-02-06T21:57:02Z

Minor comments, but looks good.

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

mergify bot requested review from a team as code owners February 1, 2023 12:01

mergify bot added the conflicts label Feb 1, 2023

cason changed the title ~~Rename Tendermint to CometBFT in /docs (backport #197)~~ v0.34.x: Rename Tendermint to CometBFT in /docs (backport #197) Feb 1, 2023

Daniel Cason added 2 commits February 1, 2023 15:45

rename: fixing cherry-pick conflicts in docs/core

f60f37d

rename: fixing further cherry-pick conflicts

1d970b7

cason reviewed Feb 1, 2023

View reviewed changes

Daniel Cason and others added 3 commits February 1, 2023 16:19

rename: Inspect section removed from docs/tools/debugging

d63df9a

rename/docs: merging tutorials, from main and v0.34.x

ea8d11b

rename/docs: links updated to v0.34.x branch

aa96ee3

cason self-assigned this Feb 3, 2023

cason removed the conflicts label Feb 3, 2023

Daniel and others added 5 commits February 6, 2023 10:42

Merge branch 'v0.34.x' into mergify/bp/v0.34.x/pr-197

29ce175

rename/docs: fixing docs.cometbft.com v0.34 links

a4fd7c2

Merge branch 'v0.34.x' into mergify/bp/v0.34.x/pr-197

a313ef8

docs/rename: updating links to v0.34.x branch

bf31655

rename: fixing cherry-pick conflicts

fe0c7bb

cason approved these changes Feb 6, 2023

View reviewed changes

cason force-pushed the mergify/bp/v0.34.x/pr-197 branch from 5d3588d to fe0c7bb Compare February 6, 2023 14:08

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/.vuepress/config.js Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/.vuepress/config.js Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/app-dev/abci-cli.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/app-dev/app-architecture.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/core/using-cometbft.md Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Show resolved Hide resolved

Daniel and others added 4 commits February 6, 2023 17:05

Apply suggestions from code review

aeef491

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

rename/docs: reintroducing time_iota_ms parameter

40278e8

Merge branch 'v0.34.x' into mergify/bp/v0.34.x/pr-197

ed671e7

Merge branch 'v0.34.x' into mergify/bp/v0.34.x/pr-197

ec8af64

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Outdated Show resolved Hide resolved

jmalicevic reviewed Feb 6, 2023

View reviewed changes

docs/tutorials/go-built-in.md Outdated Show resolved Hide resolved

jmalicevic approved these changes Feb 6, 2023

View reviewed changes

Apply suggestions from code review

f4f2667

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

cason merged commit 9eecf8a into v0.34.x Feb 7, 2023

cason deleted the mergify/bp/v0.34.x/pr-197 branch February 7, 2023 07:18

	[releases]: https://github.com/cometbft/cometbft/blob/main/RELEASES.md#large-scale-testnets
	[releases]: https://github.com/cometbft/cometbft/blob/v0.34.x/RELEASES.md#large-scale-testnets


		key, value := parts[0], parts[1]

		// check if the same key=value already exists

	Finally, make sure to add the bytes package to the `import` stanza at the top of `app.go`:
	Finally, make sure to add the bytes package to the `import` statement at the top of `app.go`:

Conversation

mergify bot commented Feb 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cason Feb 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jmalicevic commented Feb 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cason Feb 6, 2023 •

edited

Loading