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

Relayer documentation #542

Closed
5 tasks
andynog opened this issue Jan 19, 2021 · 1 comment · Fixed by #589
Closed
5 tasks

Relayer documentation #542

andynog opened this issue Jan 19, 2021 · 1 comment · Fixed by #589
Assignees
@andynog
Labels
I: documentation Internal: improvements or additions to documentation O: usability Objective: cause to improve the user experience (UX) and ease using the product
Milestone
v0.1.0

Comments

@andynog
Copy link
Contributor

andynog commented Jan 19, 2021

Summary

Documentation for the Rust Relayer

Problem Definition

Currently the documentation for setting up a relayer with two chains is outdated or missing. There's not current easy way to setup a relayer without some previous knowledge on how to do it or ask for assistance.

Proposal

Create initial documentation and instructions up to date for the relayer.

Create docs using some framework e.g. mdbook or VuePress that can render the site automatically when docs are updated.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@andynog andynog added I: documentation Internal: improvements or additions to documentation O: usability Objective: cause to improve the user experience (UX) and ease using the product labels Jan 19, 2021
@andynog andynog added this to the v0.1.0 milestone Jan 19, 2021
@andynog andynog self-assigned this Jan 19, 2021
@adizere
Copy link
Member

adizere commented Jan 20, 2021 •
edited
Loading

  • cleanup the example .toml configurations: there's currently three of them under version control and it's not clear why and what are each used for. there should be a single canonical example, and only that should appear in the docs/readmes:
    • relayer/tests/config/fixtures/relayer_conf_example.toml and
    • relayer-cli/tests/fixtures/two_chains.toml and
    • relayer/tests/config/fixtures/simple_config.toml.

After a more detailed look, I think we should delete relayer/tests/config/fixtures/simple_config.toml and update all code-comments, as well as documentation, to refer to relayer-cli/tests/fixtures/two_chains.toml. The file relayer/tests/config/fixtures/relayer_conf_example.toml is used in tests should not be visible to users.

@adizere adizere mentioned this issue Jan 26, 2021
Closed
13 tasks
@ancazamfir ancazamfir mentioned this issue Jan 28, 2021
Closed
17 tasks
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Initial documentation using mdbook (#542)
d0ecb5e
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added README page to the guide with instructions. Fix index page (#542)
d135e7c
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added more content mostly in the configuration section (#542)
f157f17
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Some cleaning up and adding some placeholder content to a few pages (#…
80cbee8 
…542)
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added information to the index page (#542)
3b33199
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added more content, new sections (most under in transactions), added …
6ad4092 
…glossary (#542)
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added info to light client page, additional theme change and some str…
7f9461c 
…ucture refactor (#542)
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added content for keys. Updated some commands references. (#542)
42a78e2
andynog added a commit that referenced this issue Jan 28, 2021
@andynog
Added tutorial section. Breakdown tutorial (#542)
0142cc9
andynog added a commit that referenced this issue Jan 29, 2021
@andynog
More content to tutorial (#542)
fa94412
@romac romac mentioned this issue Jan 29, 2021
Merged
20 tasks
andynog added a commit that referenced this issue Jan 29, 2021
@andynog
Adding more content to tutorial (#542)
0d073a0
andynog added a commit that referenced this issue Jan 31, 2021
@andynog
Adding more content, fixing content mostly in local chains file (#542)
a0a79ff
andynog added a commit that referenced this issue Feb 1, 2021
@andynog
Fixing some content to show hermes (#542)
c3600f9
andynog added a commit that referenced this issue Feb 1, 2021
@andynog
Adding guide build CI workflow (#542)
c307b3b
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Some css changes to better show few things (#542)
109c24a
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
File to support custom domain (#542)
91dfdf3
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Adding step to install mdbook-mermaid (#542)
5b107a2
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Adding step to install mdbook-mermaid on CI (#542)
d42efe8
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Removing full path from config example (#542)
22e8498
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Fixing type in guide.yml (#542)
f8cc045
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Breakdown of the relay packets into separate sections (#542)
b9c9957
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Fixing color for navigation buttons in mobile display (#542)
b81268f
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Fix gaia version (#542)
5857a29
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Added pre-requisite (Golang) needed for gaia (#542)
4edfd76
andynog added a commit that referenced this issue Feb 2, 2021
@andynog
Adding more content to the local_chains page (#542)
dc00041
@romac romac closed this as completed in #589 Feb 4, 2021
romac added a commit that referenced this issue Feb 4, 2021
@romac @andynog
@ebuchman @ancazamfir @adizere
Relayer documentation (#589)
1f2e72d 
* Initial documentation using mdbook (#542)

* Added README page to the guide with instructions. Fix index page (#542)

* Added more content mostly in the configuration section (#542)

* Some cleaning up and adding some placeholder content to a few pages (#542)

* Added information to the index page (#542)

* Added more content, new sections (most under in transactions), added glossary (#542)

* Added info to light client page, additional theme change and some structure refactor (#542)

* Added content for keys. Updated some commands references. (#542)

* Added tutorial section. Breakdown tutorial (#542)

* More content to tutorial (#542)

* Adding more content to tutorial (#542)

* Update relay_packets.md

* Adding more content, fixing content mostly in local chains file (#542)

* Fixing some content to show hermes (#542)

* Added content to the create-client section (#452)

* Review sections 1-3

* Revew 3.1, remove loop_config, add config_example.toml

* Small layout change

* fix CLI examples

* fixed and clarified ID parameters

* Format bytearrays as hex-encoded strings in various commands

* Formatting

* Added 4.3.1 and 4.5.1

* fix query client doc

* fix query client connections doc

* Add the relayer_loop doc

* Add documentation for tx raw connection commands and change from positional arguments to flags

* Avoid duplicate tag name for ConnectionEnd, ChannelEnd, AnyConsensusState and AnyClientState

* Fix JSON output in `tx raw` connection guide

* Update guide following 1ed6147

* Remove tags on ChannelEnd and ConnectionEnd

* Add documentation for query connection commands

* json for client commands, fix in relayer loop doc

* Add documentation for query channel(s) commands

* Improve output of Python script a bit

* Adding guide build CI workflow (#542)

* tx packet section, changed packet-send to ft-transfer

* Some css changes to better show few things (#542)

* formatting

* Work around gumdrop limitation which cuts off flags help text if too long

* Add documentation for tx raw chan-* commands

* Fix typo in e2e Python script

* Adapt e2e script to new flags of tx conn commands

* Add stub doc for tx raw chan-close-* commands

* Fix typo

* Improve tx raw conn-* doc

* Improve tx raw chan-open-* doc

* Only return a single result from Output type, to avoid unnecessary brackets in JSON output

* Add diagrams to tx channel and tx connection pages

* packet query docs

* starting on feature summary

* Fix typo

* Adapt mermaid theme to mdbook theme

* Add chan-close results to doc and to e2e script (disabled for now)

* Rename events to listen mode and add listen command

* File to support custom domain (#542)

* Fix mermaid theme detection

* Improve conn and chan diagrams

* Adding step to install mdbook-mermaid (#542)

* Adding step to install mdbook-mermaid on CI (#542)

* Removing full path from config example (#542)

* Remove log statement

* Fixing type in guide.yml (#542)

* renamed troubleshoot [test]

* Look for default config in ~/.hermes/config.toml and update guide

* Minor stylistic change

* Added Help

* Split dev-env script into setup-chains and init-clients

* Breakdown of the relay packets into separate sections (#542)

* Fixed links in help.md

* Formatting

* Fixing color for navigation buttons in mobile display (#542)

* Fix gaia version (#542)

* Added pre-requisite (Golang) needed for gaia (#542)

* Adding more content to the local_chains page (#542)

* remove order flag from tx chan clis

* Add high level content in transactions

* add clarification on identifiers and start cleaning 4.1.3 subsections

* restructure tutorial

* add relay path tutorial

* Finish the channel close handshake commands referrence

* remove forgotten wip

* Move chan-close commands to their own section

* Remove duplicate content

* Moved miscellaneous into help. Consolidated the help section.

* review 1-3

* Add section to install hermes via cargo install

* Rename Setup page to Installation

* Patching gaia

* features and matrix

* Add [[connections]] section to config.toml

* Whitespace

* Touch up feature matrix a bit

* small nits

* Uppercase feature descriptions

* typo fix and added link

* merge features in a new column in matrix, fix a few entries

* cleanup

* formatting

* Index nits

* Getting started, prereq

* Fixed hyperlinks to installation.md

* remove the operation instructions

* Fixed tutorial URLS

* Fixed URLS in commands and local_chains.md

* Queries overview

* Relayer CLI readme stripped down to essentials

* changelog

* review up to 5.2

* review  5.3

* review  5.4

* finish 5 review

* Add instructions for running two relayers for bidirectional relaying

* Fix broken links found with mdbook-linkcheck

* Check for broken links on CI

* Revert "Check for broken links on CI"

This reverts commit c4f8509.

* Main readme. Some fixes

* Fix typo

* Hermes <> IBC Relayer CLI

* Fix a couple more typos

* Unify Transactions and Queries index pages

* Remove $ prefix in front of commands for easier copy-paste

* fix concurrent packet relay section

* Update title of two paths page

* Disambiguation Hermes<>CLI

* More explanation re: CLI

* Nit in readme

* Casing and descriptions

* More casing

* Formatting

* Consistent casing in sidebar

* nits

* Unify notes

* Nitpick

* Minor stuff

Co-authored-by: Andy Nogueira <me@andynogueira.dev>
Co-authored-by: Ethan Buchman <ethan@coinculture.info>
Co-authored-by: Anca Zamfir <zamfiranca@gmail.com>
Co-authored-by: Adi Seredinschi <adi@informal.systems>
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this issue Sep 13, 2022
@romac @andynog
@ebuchman @ancazamfir @adizere
Relayer documentation (informalsystems#589)
b540b42 
* Initial documentation using mdbook (informalsystems#542)

* Added README page to the guide with instructions. Fix index page (informalsystems#542)

* Added more content mostly in the configuration section (informalsystems#542)

* Some cleaning up and adding some placeholder content to a few pages (informalsystems#542)

* Added information to the index page (informalsystems#542)

* Added more content, new sections (most under in transactions), added glossary (informalsystems#542)

* Added info to light client page, additional theme change and some structure refactor (informalsystems#542)

* Added content for keys. Updated some commands references. (informalsystems#542)

* Added tutorial section. Breakdown tutorial (informalsystems#542)

* More content to tutorial (informalsystems#542)

* Adding more content to tutorial (informalsystems#542)

* Update relay_packets.md

* Adding more content, fixing content mostly in local chains file (informalsystems#542)

* Fixing some content to show hermes (informalsystems#542)

* Added content to the create-client section (informalsystems#452)

* Review sections 1-3

* Revew 3.1, remove loop_config, add config_example.toml

* Small layout change

* fix CLI examples

* fixed and clarified ID parameters

* Format bytearrays as hex-encoded strings in various commands

* Formatting

* Added 4.3.1 and 4.5.1

* fix query client doc

* fix query client connections doc

* Add the relayer_loop doc

* Add documentation for tx raw connection commands and change from positional arguments to flags

* Avoid duplicate tag name for ConnectionEnd, ChannelEnd, AnyConsensusState and AnyClientState

* Fix JSON output in `tx raw` connection guide

* Update guide following 1ed6147

* Remove tags on ChannelEnd and ConnectionEnd

* Add documentation for query connection commands

* json for client commands, fix in relayer loop doc

* Add documentation for query channel(s) commands

* Improve output of Python script a bit

* Adding guide build CI workflow (informalsystems#542)

* tx packet section, changed packet-send to ft-transfer

* Some css changes to better show few things (informalsystems#542)

* formatting

* Work around gumdrop limitation which cuts off flags help text if too long

* Add documentation for tx raw chan-* commands

* Fix typo in e2e Python script

* Adapt e2e script to new flags of tx conn commands

* Add stub doc for tx raw chan-close-* commands

* Fix typo

* Improve tx raw conn-* doc

* Improve tx raw chan-open-* doc

* Only return a single result from Output type, to avoid unnecessary brackets in JSON output

* Add diagrams to tx channel and tx connection pages

* packet query docs

* starting on feature summary

* Fix typo

* Adapt mermaid theme to mdbook theme

* Add chan-close results to doc and to e2e script (disabled for now)

* Rename events to listen mode and add listen command

* File to support custom domain (informalsystems#542)

* Fix mermaid theme detection

* Improve conn and chan diagrams

* Adding step to install mdbook-mermaid (informalsystems#542)

* Adding step to install mdbook-mermaid on CI (informalsystems#542)

* Removing full path from config example (informalsystems#542)

* Remove log statement

* Fixing type in guide.yml (informalsystems#542)

* renamed troubleshoot [test]

* Look for default config in ~/.hermes/config.toml and update guide

* Minor stylistic change

* Added Help

* Split dev-env script into setup-chains and init-clients

* Breakdown of the relay packets into separate sections (informalsystems#542)

* Fixed links in help.md

* Formatting

* Fixing color for navigation buttons in mobile display (informalsystems#542)

* Fix gaia version (informalsystems#542)

* Added pre-requisite (Golang) needed for gaia (informalsystems#542)

* Adding more content to the local_chains page (informalsystems#542)

* remove order flag from tx chan clis

* Add high level content in transactions

* add clarification on identifiers and start cleaning 4.1.3 subsections

* restructure tutorial

* add relay path tutorial

* Finish the channel close handshake commands referrence

* remove forgotten wip

* Move chan-close commands to their own section

* Remove duplicate content

* Moved miscellaneous into help. Consolidated the help section.

* review 1-3

* Add section to install hermes via cargo install

* Rename Setup page to Installation

* Patching gaia

* features and matrix

* Add [[connections]] section to config.toml

* Whitespace

* Touch up feature matrix a bit

* small nits

* Uppercase feature descriptions

* typo fix and added link

* merge features in a new column in matrix, fix a few entries

* cleanup

* formatting

* Index nits

* Getting started, prereq

* Fixed hyperlinks to installation.md

* remove the operation instructions

* Fixed tutorial URLS

* Fixed URLS in commands and local_chains.md

* Queries overview

* Relayer CLI readme stripped down to essentials

* changelog

* review up to 5.2

* review  5.3

* review  5.4

* finish 5 review

* Add instructions for running two relayers for bidirectional relaying

* Fix broken links found with mdbook-linkcheck

* Check for broken links on CI

* Revert "Check for broken links on CI"

This reverts commit c4f8509.

* Main readme. Some fixes

* Fix typo

* Hermes <> IBC Relayer CLI

* Fix a couple more typos

* Unify Transactions and Queries index pages

* Remove $ prefix in front of commands for easier copy-paste

* fix concurrent packet relay section

* Update title of two paths page

* Disambiguation Hermes<>CLI

* More explanation re: CLI

* Nit in readme

* Casing and descriptions

* More casing

* Formatting

* Consistent casing in sidebar

* nits

* Unify notes

* Nitpick

* Minor stuff

Co-authored-by: Andy Nogueira <me@andynogueira.dev>
Co-authored-by: Ethan Buchman <ethan@coinculture.info>
Co-authored-by: Anca Zamfir <zamfiranca@gmail.com>
Co-authored-by: Adi Seredinschi <adi@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andynog andynog

Labels
I: documentation Internal: improvements or additions to documentation O: usability Objective: cause to improve the user experience (UX) and ease using the product
Projects
None yet
Milestone
v0.1.0
Development

Successfully merging a pull request may close this issue.

Relayer documentation informalsystems/hermes
2 participants
@adizere @andynog