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: config file #3042

Merged
merged 18 commits into from
Nov 22, 2022
Merged

docs: config file #3042

merged 18 commits into from
Nov 22, 2022

Conversation

fadeev
Copy link
Contributor

@fadeev fadeev commented Nov 2, 2022 •
edited
Loading

Updating to v1 and switching to a more descriptive format.

The problem I have with existing config documentation is that it's table-based. Even though I authored this, I always had issues with using it to remind myself what's available in the config file.

Instead of tables, I think it should be a mix of YAML examples ready to be copy-pasted and a rich plain-text description of all edge-cases and features.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 2, 2022

Visit the preview URL for this PR (updated for commit b2f8eaa):

https://ignitesrvc-d--pr3042-docs-config-b2a80wds.web.app

(expires Wed, 09 Nov 2022 12:47:44 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 60382552e86c69890c026e09478220ea153394a8

@fadeev fadeev linked an issue Nov 2, 2022 that may be closed by this pull request
Update config.yml documentation for the new version v1 #3039
Closed
@fadeev fadeev added the skip-changelog Don't check changelog for new entries label Nov 2, 2022
@fadeev
Copy link
Contributor Author

fadeev commented Nov 3, 2022

Not documenting the home property in validators, because it's not working for me. The chain fails to start if home is something other than the standard path.

@jaybxyz jaybxyz mentioned this pull request Nov 4, 2022
Closed
@jeronimoalbi
Copy link
Member

Is there intention to merge these changes? It looks good to do so 👍.
We should update the config docs as they are outdated and might lead to confusion.

@fadeev fadeev marked this pull request as ready for review November 8, 2022 11:40
@fadeev
Copy link
Contributor Author

fadeev commented Nov 10, 2022

How about we merge and I'll create an issue for this? The validator home doesn't work for me and we are not sure about the keyring. Might as well publish the updated guide and add some information later on.

@jeronimoalbi
Copy link
Member

Oh, there is a conflict with one file to be resolved

@fadeev fadeev requested a review from jeronimoalbi November 10, 2022 16:13
@github-actions
Copy link
Contributor

github-actions bot commented Nov 10, 2022 •
edited
Loading

Visit the preview URL for this PR (updated for commit 4d6f46c):

https://igntservices-docs--pr3042-docs-config-qk7dho6i.web.app

(expires Fri, 18 Nov 2022 17:06:11 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 95379efd94dd497aaa37c2d0354e6e2cafca5ec5

jeronimoalbi
jeronimoalbi previously approved these changes Nov 10, 2022
View reviewed changes
@aljo242
Copy link
Contributor

aljo242 commented Nov 11, 2022

tysm @fadeev. Will merge once we open that issue you mentioned.

@aljo242 aljo242 changed the base branch from develop to main November 15, 2022 13:52
@aljo242 aljo242 dismissed jeronimoalbi’s stale review November 15, 2022 13:52

The base branch was changed.

@fadeev fadeev mentioned this pull request Nov 18, 2022
Closed
@fadeev
Copy link
Contributor Author

fadeev commented Nov 18, 2022 •
edited
Loading

@aljo242 @jeronimoalbi added a note about home and created an issue about keyrings.

@fadeev fadeev requested a review from jeronimoalbi November 18, 2022 07:18
@tbruyelle
Copy link
Contributor

Extremely useful changes to the docs, awesome!

@fadeev fadeev requested a review from tbruyelle November 19, 2022 09:35
tbruyelle
tbruyelle previously approved these changes Nov 19, 2022
View reviewed changes
@aljo242 aljo242 merged commit 9909959 into main Nov 22, 2022
@aljo242 aljo242 deleted the docs/config branch November 22, 2022 14:30
Jchicode pushed a commit to Jchicode/cli that referenced this pull request Aug 9, 2023
@fadeev @tbruyelle @jeronimoalbi
docs: config file (ignite#3042)
ff5092b 
* docs: config file

* build section

* faucet and genesis

* validators section

* add a note about the home perty in validators

* wrap at 80 chars

* update config

* Update docs/docs/kb/03-config.md

Co-authored-by: Thomas Bruyelle <[email protected]>

* fix: key pair generated outside of Ignite

* Update docs/docs/kb/03-config.md

Co-authored-by: Jerónimo Albi <[email protected]>

Co-authored-by: Alex Johnson <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Jerónimo Albi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tbruyelle tbruyelle tbruyelle approved these changes

@jeronimoalbi jeronimoalbi jeronimoalbi approved these changes

@ilgooz ilgooz Awaiting requested review from ilgooz ilgooz is a code owner

@aljo242 aljo242 Awaiting requested review from aljo242

@lumtis lumtis Awaiting requested review from lumtis

Assignees
No one assigned
Labels
skip-changelog Don't check changelog for new entries
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update config.yml documentation for the new version v1
4 participants
@fadeev @jeronimoalbi @aljo242 @tbruyelle