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

Cleanup of tx raw content from the Hermes guide #2466

Closed
1 of 6 tasks
adizere opened this issue Jul 26, 2022 · 1 comment · Fixed by #2522
Closed
1 of 6 tasks

Cleanup of tx raw content from the Hermes guide #2466

adizere opened this issue Jul 26, 2022 · 1 comment · Fixed by #2522
Labels
A: good-first-issue Admin: good for newcomers I: guide Internal: issues with the Hermes guide O: usability Objective: cause to improve the user experience (UX) and ease using the product
Milestone

Comments

@adizere
Copy link
Member

adizere commented Jul 26, 2022

Summary

Hermes users should avoid using tx raw (renamed into tx) CLIs, because these are mostly intended for developers and testing. The Hermes guide, however, instructs users to use tx raw at various points, eg to create channel. This can create confusion & can lead users to relying too much on these CLIs.

Proposal

Move the tx related guidelines out of the guide and in a different place. The guide should increasingly be targeting end-users.

Acceptance Criteria

  • the Hermes guide focuses on user recipes, not developer use-cases.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@adizere adizere added A: good-first-issue Admin: good for newcomers O: usability Objective: cause to improve the user experience (UX) and ease using the product I: guide Internal: issues with the Hermes guide labels Jul 26, 2022
@adizere adizere added this to the v1.2 milestone Jul 26, 2022
@AlianBenabdallah
Copy link
Contributor

We might propose a new design for the guide. If so, there will be a lot of modifications including tx raw.

romac added a commit that referenced this issue Aug 3, 2022
@romac romac modified the milestones: v1.2, v1.0.0 Aug 3, 2022
romac added a commit that referenced this issue Aug 8, 2022
romac added a commit that referenced this issue Aug 8, 2022
* Bump Hermes to v1.0.0-rc.2

* Bump crates to 0.18.0 and ibc-proto to 0.19.1

* Update lockfile

* Add self-documenting `help` target to the Makefile

* Remove tutorial with raw commands from the guide

* Add changelog entry for #2459

* Update changelog and upgrading instructions

* Release version 1.0.0-rc.2 of the changelog

* Add changelog entry for #2466

* Add changelog entry for #2380

* Bump tendermint-rs dependencies to 0.23.9

* Bump prost to version 0.11

* Regenerate protos with Prost 0.11

* Update lockfiles

* Use our own fork of `ics23` with Prost 0.11

* Bump `ibc-proto` version to 0.20.0 because of the Prost update

* Bump `ics23` to 0.8.0

* Fix comment in proto definition

* Fix no-std-check Makefile

* Update `ics23` to version 0.8.1

* Update lockfile

* Fix typo
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this issue Sep 13, 2022
* Bump Hermes to v1.0.0-rc.2

* Bump crates to 0.18.0 and ibc-proto to 0.19.1

* Update lockfile

* Add self-documenting `help` target to the Makefile

* Remove tutorial with raw commands from the guide

* Add changelog entry for informalsystems#2459

* Update changelog and upgrading instructions

* Release version 1.0.0-rc.2 of the changelog

* Add changelog entry for informalsystems#2466

* Add changelog entry for informalsystems#2380

* Bump tendermint-rs dependencies to 0.23.9

* Bump prost to version 0.11

* Regenerate protos with Prost 0.11

* Update lockfiles

* Use our own fork of `ics23` with Prost 0.11

* Bump `ibc-proto` version to 0.20.0 because of the Prost update

* Bump `ics23` to 0.8.0

* Fix comment in proto definition

* Fix no-std-check Makefile

* Update `ics23` to version 0.8.1

* Update lockfile

* Fix typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: good-first-issue Admin: good for newcomers I: guide Internal: issues with the Hermes guide O: usability Objective: cause to improve the user experience (UX) and ease using the product
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants