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: 10180 Fix SDK #10237

Merged
merged 17 commits into from Sep 28, 2021
Merged

Conversation

brennhill
Copy link
Contributor

Description

Closes: #10180 #10180

Fixes how we refer to the SDK throughout the documentation.


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 type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • [NA] followed the guidelines for building modules
  • [NA] included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • [NA] included comments for documenting Go code
  • [NA] updated the relevant documentation or specification
  • [NA] reviewed "Files changed" and left comments if necessary
  • [NA] 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 type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@github-actions github-actions bot added the T: ADR An issue or PR relating to an architectural decision record label Sep 27, 2021
@barriebyron
Copy link
Contributor

barriebyron commented Sep 27, 2021

oops @brennhill to make these types of changes more manageable, I had limited the scope in #10180

The scope of this GitHub issue and your PR is limited to the Cosmos SDK Introduction topic https://docs.cosmos.network/master/intro/ and child topics.

and had staged the issue to be used in October Codefest but am so so happy to see contributors jump in to make improvements no matter when they do the work!

can you take a look @aaronc and @alexanderbez ? please and thank you

@barriebyron
Copy link
Contributor

@brennhill did you want to close this PR and then open a different PR in the month of October, and please limit your scope

@brennhill brennhill changed the title docs:10180 Fix SDK docs: 10180 Fix SDK Sep 27, 2021
@brennhill
Copy link
Contributor Author

@barriebryon I could do that but I don't need to wait until october. If the changes are good I'd rather you go ahead and use them. It frees up my mind for other things.

@barriebyron
Copy link
Contributor

barriebyron commented Sep 27, 2021

@brennhill thanks for being willing to make these improvements! Sounds good to me, and I look forward to your continued contributions. Grab an issue during October if you want to participate in October Codefest.

Any fixes for the codebase are good fixes and we appreciate you!

@barriebyron barriebyron self-requested a review September 27, 2021 13:27
Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

so many good changes, thank you @brennhill can you check your "an" and make changes as required ?

docs/core/context.md Outdated Show resolved Hide resolved
docs/architecture/adr-010-modular-antehandler.md Outdated Show resolved Hide resolved
docs/basics/README.md Outdated Show resolved Hide resolved
docs/basics/accounts.md Outdated Show resolved Hide resolved
docs/building-modules/intro.md Outdated Show resolved Hide resolved
docs/building-modules/intro.md Outdated Show resolved Hide resolved
docs/building-modules/intro.md Outdated Show resolved Hide resolved
docs/core/baseapp.md Outdated Show resolved Hide resolved
docs/core/baseapp.md Outdated Show resolved Hide resolved
brennhill and others added 11 commits September 28, 2021 08:22
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

thank you so much for helping with our consistent branding, @brennhill!

Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

For future reference, do we want to always put Cosmos next to SDK, even when we say "the SDK"?

@robert-zaremba robert-zaremba added A:automerge Automatically merge PR once all prerequisites pass. and removed T: ADR An issue or PR relating to an architectural decision record labels Sep 28, 2021
@github-actions github-actions bot added the T: ADR An issue or PR relating to an architectural decision record label Sep 28, 2021
@barriebyron
Copy link
Contributor

For future reference, do we want to always put Cosmos next to SDK, even when we say "the SDK"?

yes @robert-zaremba we do! Branding, especially in docs, is essential. Using the full "Cosmos SDK" is essential. For example, when a bit of a doc gets shared in the world at large, we want to make sure our reader knows "the SDK" is "the Cosmos SDK"

Thanks for asking!

@robert-zaremba robert-zaremba merged commit a47bd59 into cosmos:master Sep 28, 2021
@brennhill brennhill deleted the docs-Fix-Cosmos-SDK branch October 2, 2021 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T: ADR An issue or PR relating to an architectural decision record
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix:Cosmos SDK Intro topics - make all references to Cosmos SDK consistent, apply guidelines
5 participants