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.

Sign up for GitHub

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

Jump to bottom

docs:(x/auth/spec/01_concepts.md) add comparative content to differentiate from authz module #10178

Closed
4 tasks
barriebyron opened this issue Sep 16, 2021 · 2 comments · Fixed by #10238
Closed
4 tasks

docs:(x/auth/spec/01_concepts.md) add comparative content to differentiate from authz module #10178

barriebyron opened this issue Sep 16, 2021 · 2 comments · Fixed by #10238
Assignees
@likhita-809
Labels
good first issue T:Docs Changes and features related to documentation.

Comments

@barriebyron
Copy link
Contributor

barriebyron commented Sep 16, 2021 •
edited
Loading

Summary

With the addition of the authz module, there is top-level confusion of the two similar module names. We'll benefit from updating the Cosmos SDK > List of Modules > auth topic by adding a description of how this auth module is different from authz.

Problem Definition

from a glance, the module names auth and authz are similar.

Proposal

update the https://github.com/cosmos/cosmos-sdk/blob/master/x/auth/spec/01_concepts.md file to clearly define the difference

  • auth - authentication of accounts and transactions for Cosmos SDK applications and is responsible for specifying the base transaction and account types
  • authz - authorization for accounts to perform actions on behalf of other accounts and enables a granter to grant authorizations to a grantee that allows the grantee to execute messages on behalf of the granted

Use Markdown syntax to link back to the auth module.

Extra points for improving the clarity of language, using present tense (the auth module is already being used in the Cosmos SDK, although the topic still states "will be"), and applying solid technical content style improvements

Be sure to follow these guidelines:

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@barriebyron barriebyron mentioned this issue Sep 16, 2021
Merged
@barriebyron barriebyron changed the title feat:(x/auth/spec/01_concepts.md) add comparative content to differentiate from authz module feat:docs (x/auth/spec/01_concepts.md) add comparative content to differentiate from authz module Sep 20, 2021
@barriebyron barriebyron changed the title feat:docs (x/auth/spec/01_concepts.md) add comparative content to differentiate from authz module docs:(x/auth/spec/01_concepts.md) add comparative content to differentiate from authz module Sep 21, 2021
@barriebyron barriebyron added the T:Docs Changes and features related to documentation. label Sep 23, 2021
brennhill added a commit to brennhill/cosmos-sdk that referenced this issue Sep 27, 2021
@brennhill
docs:cosmos#10178 reference authz from auth
3881eb3
mergify bot pushed a commit that referenced this issue Sep 30, 2021
@brennhill
docs: #10178 reference authz from auth (#10238)
a237f5a 
## Description

Closes: #178

Adds the requested differential language between auth and authz modules.  Resolves instances of future tense that were noticed.

---

### 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...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [NA] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [NA] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [NA] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [NA] added a changelog entry to `CHANGELOG.md`
- [NA] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
@likhita-809 likhita-809 self-assigned this Sep 30, 2021
@likhita-809
Copy link
Contributor

can we close this issue, since it is already addressed in #10238 ?

@barriebyron barriebyron mentioned this issue Oct 18, 2021
Merged
12 tasks
@barriebyron
Copy link
Contributor Author

oh I see, there issue number had a typo in it, thanks for your contribution, closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@likhita-809 likhita-809

Labels
good first issue T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: #10178 reference authz from auth brennhill/cosmos-sdk
2 participants
@barriebyron @likhita-809