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

Improve visibility of config auto command #3301

Merged
merged 13 commits into from
May 23, 2023
Merged

Improve visibility of config auto command #3301

merged 13 commits into from
May 23, 2023

Conversation

seanchen1991
Copy link
Contributor

Closes: #3283

Description

Improves the help text of the config auto command to make it more visible. The command is also now more visible in the guide.

PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests: integration (for Hermes) or unit/mock tests (for modules).
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

@seanchen1991 seanchen1991 requested a review from ljoss17 May 2, 2023 21:07
ljoss17
ljoss17 reviewed May 3, 2023
View reviewed changes
Copy link
Contributor

@ljoss17 ljoss17 left a comment

Choose a reason for hiding this comment

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

This look great! I left some suggestions

config.toml Show resolved Hide resolved
guide/src/documentation/configuration/configure-hermes.md Outdated Show resolved Hide resolved
romac
romac approved these changes May 17, 2023
View reviewed changes
Copy link
Member

@romac romac left a comment

Choose a reason for hiding this comment

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

Great work @seanchen1991!

ljoss17
ljoss17 approved these changes May 23, 2023
View reviewed changes
Copy link
Contributor

@ljoss17 ljoss17 left a comment

Choose a reason for hiding this comment

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

This looks great!

@romac romac merged commit 7a619d3 into master May 23, 2023
@romac romac deleted the sean/config-auto-discoverability branch May 23, 2023 11:37
@romac romac modified the milestone: v1.5 May 23, 2023
pratikbin pushed a commit to pratikbin/hermes that referenced this pull request May 24, 2023
@seanchen1991 @romac
Improve visibility of config auto command (informalsystems#3301)
f8e4b01 
* Add comment about config auto command to example config.toml

* Improve help message for config auto command

* Make it more apparent in the guide that config files can be generated

* Reference the config-auto command more in the guide

* Cargo fmt

* Update guide templates

* Update guide templates

* Incorporate PR feedback

* Fix command templates

* Add gaia version template

* Use gaia version template

---------

Signed-off-by: Sean Chen <seanchen11235@gmail.com>
Co-authored-by: Romain Ruetschi <romain@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ljoss17 ljoss17 ljoss17 approved these changes

@romac romac romac approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve the discoverability around the hermes config auto command
3 participants
@seanchen1991 @romac @ljoss17