Add initial QGB Docs #279

YazzyYaz · 2022-10-31T12:41:29Z

Closes #222

Things Left To Do:

Update Mockups
Show Logs
Show EVM Key Generation
Show local QGB Network Instantiation

rach-id

Awesome first iterations 🔥
Left some comments and suggestions

docs/nodes/qgb.md

jcstein · 2022-10-31T14:07:47Z

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

…gb_docs

github-actions · 2022-10-31T16:02:21Z

PR Preview Action v1.2.0
🚀 Deployed preview to https://celestiaorg.github.io/docs/pr-preview/pr-279/
on branch `gh-pages` at 2022-10-31 21:35 UTC

rach-id

second pass, added more suggestions

docs/nodes/qgb.md

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

rach-id · 2022-11-01T08:02:19Z

@YazzyYaz @jcstein does it make sense to add a section where you can run a local version of the QGB? Or this should belong in the repo?

jcstein · 2022-11-02T09:31:20Z

@sweexordious I think it does make sense to include, but maybe not for first iteration so we can push this live?

rach-id · 2022-11-02T10:45:02Z

@jcstein Yes, 100%, sounds good, we can remember it or create an issue for it.

@sweexordious

adding suggestions from @sweexordious Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

YazzyYaz · 2022-11-02T17:12:00Z

@sweexordious where can we find examples of running a local version of the QGB?

Is it the init-chain.sh or docker-compose build or both? Happy to add them to the PR.

rach-id · 2022-11-02T17:13:57Z

Which do you prefer? A network where they have to run similar to running a validator?
Or an automatic docker compose script that starts with a single command and spins up eveytuing automatically?

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

rach-id

Added some logs + how to run details

docs/nodes/qgb.md

jcstein · 2022-11-05T13:02:37Z

Thank you, I'll review when back home @sweexordious!

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

evan-forbes · 2022-11-28T17:12:59Z

docs/nodes/qgb.md

+### Starting the Orchestrator
+
+With your celestia-app Validator running in one Terminal session, open a new
+Terminal session in order to run the Orchestrator.
+
+You can run the following command to start the Orchestrator:
+
+<!-- markdownlint-disable MD013 -->
+```sh
+celestia-appd orchestrator -x "mocha" -d <EVM-PRIVATE-KEY> --keyring-account validator --keyring-backend=test
+```
+<!-- markdownlint-enable MD013 -->
+
+The `-x` flag references the chain-id of the Celestia network. Here, we are
+connecting it to Mocha Testnet so we are using `mocha`.  
+
+The `-d` flag refers to your EVM Private Key that will be used to sign the
+transactions.
+
+`keyring-account` refers to the validator key name on Celestia.
+
+Running the orchestrator command above will show logs like the following
+output:


@sweexordious should anyone be running the orchestrator? I was under the impressing that the only people running the QGB would be us until v2

good point 👍 👍. This was written before we decided to have a separate testnet for the QGB.
So, we can remove these docs from here, and keep them somewhere until we start the QGB dedicated testnet. Thanks a lot for flagging this.

hmm, should i leave out lines 81-268 out for V1?

yes 👍 let's keep those somewhere because we will need them in the future.

sounds good. will review with @YazzyYaz

would it make sense to remove everything from ## Setting Up the QGB (line 53) on @evan-forbes / @sweexordious / @YazzyYaz ?

I'll defer to @YazzyYaz , but imo yeah. alternatively, we could just mention that we're not running the qgb on a testnet atm so these docs are not yet relevant. The end result for v2 will likely be similar, and this info is really good

sounds good, thank you Evan

jcstein · 2022-11-29T02:07:20Z

yarn.lock

-  version "7.16.7"
-  resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.16.7.tgz"
-  integrity sha512-iAXqUn8IIeBTNd72xsFlgaXHkMBMt6y4HJp1tIaK465CWLT/fG1aqB7ykr95gHHmlBdGbFeWWfyB4NJJ0nmeIg==
+"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.10.4", "@babel/code-frame@^7.16.0", "@babel/code-frame@^7.18.6", "@babel/code-frame@^7.8.3":


and I think we can revert the changes here @YazzyYaz?

jcstein · 2023-04-28T15:33:22Z

closing in favor of #668

* docs: add QGB docs * fix: anchor links in imported markdown, tables * style: add category under Validator for QGB * align with celestiaorg/orchestrator-relayer#295 * feat: add markdown import to build command * docs: update markdown files * add intro section TODO * reformat menu * docs: add intro section * fix: linting from source as test * add back QGB to titles for clarity * edit copy of intro * update from source * manually add changes from celestiaorg/orchestrator-relayer#334 * add intro and diagrams from #279 * linting * add "install" section, add variable for QGB for golang, and link to internal pages * match celestiaorg/orchestrator-relayer#337

docs: Add initial QGB Docs

ad3dd2c

YazzyYaz added the documentation Improvements or additions to documentation label Oct 31, 2022

YazzyYaz requested review from adlerjohn, rach-id, evan-forbes and jcstein October 31, 2022 12:41

YazzyYaz self-assigned this Oct 31, 2022

rach-id requested changes Oct 31, 2022

View reviewed changes

YazzyYaz and others added 3 commits October 31, 2022 16:59

Apply suggestions from code review

a2e9e3e

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

fix: Resolve merge tasks

1c055c3

Merge branch 'yaz.qgb_docs' of github.com:celestiaorg/docs into yaz.q…

78bd1db

…gb_docs

YazzyYaz and others added 2 commits October 31, 2022 17:04

fix: Resolve lint errors

d4e6d78

updated graphics

e7d0416

rach-id requested changes Oct 31, 2022

View reviewed changes

docs/nodes/qgb.md Outdated Show resolved Hide resolved

docs/nodes/qgb.md Show resolved Hide resolved

docs/nodes/qgb.md Outdated Show resolved Hide resolved

docs/nodes/qgb.md Outdated Show resolved Hide resolved

Update docs/nodes/qgb.md

5e55ee2

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

Apply suggestions from code review

705d26d

adding suggestions from @sweexordious Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

YazzyYaz and others added 2 commits November 2, 2022 18:19

Update docs/nodes/qgb.md

7a57bc0

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

doc: Add private network notes

227723d

rach-id reviewed Nov 2, 2022

View reviewed changes

Apply suggestions from code review

978685e

Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>

evan-forbes reviewed Nov 28, 2022

View reviewed changes

linting and rachid's suggestions

79a4f8c

jcstein reviewed Nov 29, 2022

View reviewed changes

jcstein added 2 commits November 30, 2022 14:45

remove v2 instructions

09c0e50

add back V2 doc to stash in PR

e9684aa

YazzyYaz marked this pull request as draft January 10, 2023 18:37

jcstein mentioned this pull request Apr 25, 2023

Add QGB docs #668

Merged

17 tasks

jcstein added a commit that referenced this pull request Apr 28, 2023

add intro and diagrams from #279

834cbac

jcstein closed this Apr 28, 2023

jcstein deleted the yaz.qgb_docs branch May 5, 2023 03:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial QGB Docs #279

Add initial QGB Docs #279

YazzyYaz commented Oct 31, 2022 •

edited by jcstein

Loading

rach-id left a comment

jcstein commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

rach-id left a comment

rach-id commented Nov 1, 2022

jcstein commented Nov 2, 2022

rach-id commented Nov 2, 2022

YazzyYaz commented Nov 2, 2022

rach-id commented Nov 2, 2022

rach-id left a comment

jcstein commented Nov 5, 2022

evan-forbes Nov 28, 2022

rach-id Nov 28, 2022

jcstein Nov 29, 2022

rach-id Nov 29, 2022

jcstein Nov 29, 2022

jcstein Nov 30, 2022 •

edited

Loading

evan-forbes Nov 30, 2022

jcstein Dec 1, 2022

jcstein Nov 29, 2022

jcstein commented Apr 28, 2023

Add initial QGB Docs #279

Add initial QGB Docs #279

Conversation

YazzyYaz commented Oct 31, 2022 • edited by jcstein Loading

rach-id left a comment

Choose a reason for hiding this comment

jcstein commented Oct 31, 2022 • edited Loading

github-actions bot commented Oct 31, 2022 • edited Loading

rach-id left a comment

Choose a reason for hiding this comment

rach-id commented Nov 1, 2022

jcstein commented Nov 2, 2022

rach-id commented Nov 2, 2022

YazzyYaz commented Nov 2, 2022

rach-id commented Nov 2, 2022

rach-id left a comment

Choose a reason for hiding this comment

jcstein commented Nov 5, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcstein Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcstein commented Apr 28, 2023

YazzyYaz commented Oct 31, 2022 •

edited by jcstein

Loading

jcstein commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

jcstein Nov 30, 2022 •

edited

Loading