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.

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: replace Tendermint references in docs with CometBFT #15339

Merged
merged 33 commits into from
Mar 14, 2023

Conversation

cipherzzz
Copy link
Contributor

@cipherzzz cipherzzz commented Mar 9, 2023

Description

Closes: #14915

Pretty much a find/replace of Tendermint with CometBFT for all the MD docs in the project. I looked at the context of each replace and it seemed to read ok and make sense to me. I am only targeting main with these changes per the issue - no backported release branches or anything.

# Issue Comment
IMHO only main/v0.48+ should have all the renaming changes in the docs

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the documentation writing guidelines
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct docs: prefix in the PR title
  • confirmed all author checklist items have been addressed
  • confirmed that this PR only changes documentation
  • reviewed content for consistency
  • reviewed content for thoroughness
  • reviewed content for spelling and grammar
  • tested instructions (if applicable)

@cipherzzz cipherzzz requested a review from a team as a code owner March 9, 2023 20:39
@cipherzzz cipherzzz marked this pull request as draft March 9, 2023 20:39
@github-actions github-actions bot added C:Confix Issues and PR related to Confix C:Cosmovisor Issues and PR related to Cosmovisor C:Store C:x/auth C:x/consensus C:x/gov C:x/slashing C:x/staking labels Mar 9, 2023
docs/docs/README.md Outdated Show resolved Hide resolved
@julienrbrt
Copy link
Member

julienrbrt commented Mar 10, 2023

IMHO only main/v0.48+ should have all the renaming changes in the docs

Right, for v0.45 and v0.46 it is not important indeed (and fortunately because the docs are completely different there 😅). At the time I wrote the issue, it was not sure if v0.47 was going to migrate or not.

Now that it did, we should backport this PR to v0.47, so the docs are correct there. Fortunately, if you only touch *.md files, there should not be any conflict in the backport :)

docs/spec/_ics/bech32.md Outdated Show resolved Hide resolved
@cipherzzz
Copy link
Contributor Author

@julienrbrt - You want me to replace

             {
               label: "Tendermint Core",
               href: "https://docs.tendermint.com",
             },

with

              {
                label: "CometBFT",
                href: "https://docs.cometbft.com",
              },

@julienrbrt
Copy link
Member

@julienrbrt - You want me to replace

             {
               label: "Tendermint Core",
               href: "https://docs.tendermint.com",
             },

with

              {
                label: "CometBFT",
                href: "https://docs.cometbft.com",
              },

question

Yes, exactly :)

@cipherzzz
Copy link
Contributor Author

@julienrbrt - You want me to replace

             {
               label: "Tendermint Core",
               href: "https://docs.tendermint.com",
             },

with

              {
                label: "CometBFT",
                href: "https://docs.cometbft.com",
              },

question

Yes, exactly :)

Ok, Done

SECURITY.md Outdated Show resolved Hide resolved
SECURITY.md Outdated Show resolved Hide resolved
docs/docs/basics/02-query-lifecycle.md Outdated Show resolved Hide resolved
docs/docs/core/03-node.md Outdated Show resolved Hide resolved
docs/docs/intro/00-overview.md Outdated Show resolved Hide resolved
docs/docs/intro/02-sdk-app-architecture.md Outdated Show resolved Hide resolved
docs/docs/intro/02-sdk-app-architecture.md Outdated Show resolved Hide resolved
docs/docs/intro/02-sdk-app-architecture.md Outdated Show resolved Hide resolved
docs/docs/intro/02-sdk-app-architecture.md Outdated Show resolved Hide resolved
store/snapshots/README.md Outdated Show resolved Hide resolved
@julienrbrt
Copy link
Member

You simply need to revert those ToC and let's merge!

@cipherzzz
Copy link
Contributor Author

You simply need to revert those ToC and let's merge!

@julienrbrt - I think we're good - famous last words....

@julienrbrt julienrbrt changed the title docs: Replace Tendermint references in Docs with CometBFT docs: replace Tendermint references in docs with CometBFT Mar 14, 2023
@julienrbrt julienrbrt merged commit 825245d into cosmos:main Mar 14, 2023
@julienrbrt
Copy link
Member

@Mergifyio backport release/v0.47.x

@mergify
Copy link
Contributor

mergify bot commented Mar 14, 2023

backport release/v0.47.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Mar 14, 2023
Co-authored-by: Julien Robert <[email protected]>
(cherry picked from commit 825245d)

# Conflicts:
#	docs/docs/basics/00-app-anatomy.md
#	docs/docs/core/07-cli.md
#	snapshots/README.md
#	tools/confix/README.md
#	tools/cosmovisor/README.md
#	x/README.md
julienrbrt added a commit that referenced this pull request Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation to refer to CometBFT
4 participants