docs: new validator docs (+ updated docs for gnoland cli) #2285

r3v4s · 2024-06-05T07:54:22Z

This PR adds the validator docs and updates old gnoland cli docs.
Closes #1820

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

leohhhn · 2024-06-05T15:56:40Z

Thanks for this.

I will take a detailed look soon, but for starters, can you move the validator docs into the gno-infrastructure folder? This folder was added in recently, and is the place for these docs 🙏

r3v4s · 2024-06-05T16:54:17Z

Thanks for this.

I will take a detailed look soon, but for starters, can you move the validator docs into the gno-infrastructure folder? This folder was added in recently, and is the place for these docs 🙏

Should I just move validator folder into gno-infrastructure, so final path would be like /docs/gno-infrastructure/validator ??

leohhhn · 2024-06-10T10:51:48Z

I suggest this structure:

docs/
    --gno-infrastructure/
            -----validators/
                ----- overview.md
                ----- running-a-validator.md
                ----- faq.md

Then, we can have the overview.md file be an index page (the page that shows up when you click on a section in the sidebar), and the two dropdowns would be Running a Validator" & "FAQ".

zivkovicmilos

I've left comments 🙏

I think it's going in a good direction, but we can do even better for the v1 of these docs. Check the comments and let me know what you think

docs/gno-tooling/cli/gnoland.md

docs/validator/faq.md

docs/validator/running-a-validator.md

docs/gno-tooling/cli/gnoland.md

r3v4s · 2024-06-10T12:58:41Z

I suggest this structure:
docs/
    --gno-infrastructure/
            -----validators/
                ----- overview.md
                ----- running-a-validator.md
                ----- faq.md
Then, we can have the overview.md file be an index page (the page that shows up when you click on a section in the sidebar), and the two dropdowns would be Running a Validator" & "FAQ".

suggestion structure looks better to me. 8a5c5ab

docs/gno-infrastructure/validators/overview.md

docs/gno-infrastructure/validators/running-a-validator.md

docs/validator/validator.md

docs/validator/running-a-validator.md

Update faq.md

…-gnoland

## Description This PR updates the broken styling, links in #2285. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>

This PR adds the `validator` docs and updates old `gnoland` cli docs. Closes gnolang#1820 <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> --------- Co-authored-by: adr-sk <andrew@onbloc.xyz> Co-authored-by: Milos Zivkovic <milos.zivkovic@tendermint.com>

## Description This PR updates the broken styling, links in gnolang#2285. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>

r3v4s added 3 commits June 5, 2024 16:45

docs: validator

50a317c

docs: update gnoland

6f10d67

docs

ce1c615

r3v4s requested a review from moul as a code owner June 5, 2024 07:54

github-actions bot assigned r3v4s Jun 5, 2024

r3v4s requested review from zivkovicmilos and leohhhn and removed request for moul June 5, 2024 07:54

r3v4s added the 📖 documentation Improvements or additions to documentation label Jun 5, 2024

r3v4s assigned adr-sk Jun 5, 2024

r3v4s changed the title ~~doc: new validator docs (+ updated docs for gnoland cli)~~ docs: new validator docs (+ updated docs for gnoland cli) Jun 5, 2024

doc

ee8431a

zivkovicmilos added this to the 🏗4️⃣ test4.gno.land milestone Jun 5, 2024

adr-sk mentioned this pull request Jun 5, 2024

Onbloc's Builder Journey gnolang/hackerspace#29

Open

r3v4s added 3 commits June 10, 2024 16:15

docs: add faq

d7486fd

docs: update missing part in running a validator

897abf0

docs

98fe009

zivkovicmilos requested changes Jun 10, 2024

View reviewed changes

r3v4s added 6 commits June 10, 2024 21:36

chore: faq id

a9da599

fix: typo engine > protocol

1ce0a77

docs: change key name

bb23df9

fix: typo

deff310

chore: change card level

c835638

docs: change structure

8a5c5ab

r3v4s added 2 commits June 11, 2024 10:41

docs: update key types

7050e46

fix: typo

2ee4fc0

docs:

1acd657

michelleellen mentioned this pull request Jun 12, 2024

Minutes: Public Dev Calls [every Wednesday] gnolang/meetings#37

Open

zivkovicmilos approved these changes Jun 24, 2024

View reviewed changes

r3v4s and others added 20 commits June 24, 2024 19:38

docs: use -data-dir and -config-path

8779009

docs: drop hardcoded results

f93622a

docs: separate start new chain, connect existing chain

1731db0

docs: wip tech faq

6e6e934

docs: fix r/sys/vals typo

02674a3

docs: remove un intended section

94c663b

Update validator set info

060b4ab

docs: add info block for overwriting secrets

8c58a0b

docs: remove unnecessary section to connect an existing gno chain

da00f05

chore

ea51e9b

docs: tech faq

ad8a9b0

Update faq.md

bdd9f4d

Merge pull request #1 from onbloc/adr-sk-patch-1

2329f9a

Update faq.md

docs: add warn and info card

3f7a6dd

docs: add examples txs into genesis

d5daa75

fix: typo in numbering

b2e52e5

Format new docs

3df29c0

Simplify infra docs

1935fa5

Merge branch 'master' into fork/onbloc/docs/new-validator-docs-update…

0c16221

…-gnoland

Fix dumb linting errors

b189e49

zivkovicmilos merged commit f74e5f0 into gnolang:master Jun 25, 2024
5 checks passed

This was referenced Jun 25, 2024

feat: align #2285 gnolang/docs.gno.land#47

Merged

fix: update validator docs styling, links #2439

Merged

zivkovicmilos deleted the docs/new-validator-docs-update-gnoland branch June 26, 2024 07:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: new validator docs (+ updated docs for gnoland cli) #2285

docs: new validator docs (+ updated docs for gnoland cli) #2285

r3v4s commented Jun 5, 2024

leohhhn commented Jun 5, 2024

r3v4s commented Jun 5, 2024

leohhhn commented Jun 10, 2024 •

edited

Loading

zivkovicmilos left a comment

r3v4s commented Jun 10, 2024

docs: new validator docs (+ updated docs for gnoland cli) #2285

docs: new validator docs (+ updated docs for gnoland cli) #2285

Conversation

r3v4s commented Jun 5, 2024

leohhhn commented Jun 5, 2024

r3v4s commented Jun 5, 2024

leohhhn commented Jun 10, 2024 • edited Loading

zivkovicmilos left a comment

Choose a reason for hiding this comment

r3v4s commented Jun 10, 2024

leohhhn commented Jun 10, 2024 •

edited

Loading