docs: add gnoland tutorial
#2162
Conversation
github-actions
bot
added
the
📦 ⛰️ gno.land
# Conflicts: # docs/gno-tooling/cli/gnoland.md
|
Not sure if this flag is in the right place. If it is, I don't really understand what it's supposed to do. Also, I found that the |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2162 +/- ##
=======================================
Coverage 54.59% 54.59%
=======================================
Files 579 579
Lines 77896 77896
=======================================
Hits 42528 42528
Misses 32195 32195
Partials 3173 3173
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Created an issue on |
There was a problem hiding this comment.
Lots of great information here. I'd recommend trimming it down a bit. This can be done by removing some of the content that should be available on a reference page. I think it would be better for two reasons:
- Content like program flags won't have to be maintained in more than one location
- Giving a command example that works is sufficient for a getting started guide and a link to more in depth reference materials will enable the reader to dive deeper if they want to.
I think perhaps this could be split into two pages under the getting started using gnoland parent.
- Configuring gnoland genesis
- Configuring and running gnoland
| @@ -24,7 +24,7 @@ func newTxsRemoveCmd(txsCfg *txsCfg, io commands.IO) *commands.Command { | |||
| return commands.NewCommand( | |||
| commands.Metadata{ | |||
| Name: "remove", | |||
| ShortUsage: "txs remove <tx-hash ...>", | |||
| ShortUsage: "txs remove [flags] <tx-hash ...>", | |||
There was a problem hiding this comment.
Does the txs add command need this too?
|
|
||
| ## Overview | ||
|
|
||
| In this tutorial, you will learn how to use the `gnoland` binary. This guide covers |
There was a problem hiding this comment.
It's probably worth it to mention this early on -- this is for running a full node -- maybe mention and link back to gnodev for someone that isn't ready to go through all of this yet. They should understand that this is probably not the first thing they want to do to experiment with building on gno.land.
| By default, the node will start listening on `localhost:26657`. | ||
|
|
||
| #### Flags | ||
| - `-chainid dev` - the ID of the chain. |
There was a problem hiding this comment.
Maybe just link to a reference page so they same information mustn't be maintained in two places?
| This command will initialize a configuration directory and file in the default | ||
| path. The node is highly configurable. Some of the main configuration options | ||
| which are available are listed below: | ||
| - Database which is used for storing node data |
There was a problem hiding this comment.
I'm not sure people care about all these in a getting started section; a link to a reference page with this information might be better.
There was a problem hiding this comment.
Coming back to this after reading the rest of this section -- it would be great to have this link to a doc that shows all the available categories and fields.
| A full configuration category, such as `consensus`, can also be read via this command: | ||
|
|
||
| ```bash | ||
| gnoland config get rpc |
There was a problem hiding this comment.
Should this be consensus instead of rpc?
| all configuration fields inside it, similar to the following: | ||
|
|
||
| ```bash | ||
| { tcp://127.0.0.1:26657 [*] [HEAD GET POST OPTIONS] [Origin Accept Content-Type X-Requested-With X-Server-Time] 900 false 900 10s 1000000 1048576 } |
There was a problem hiding this comment.
This is a bit confusing. The example went from rpc, to consensus, and back to rpc again. Is there an option to have the output labeled by field? That would be more helpful for people imo. Otherwise maybe omit the output; I'm no sure it adds much.
|
|
||
| The node genesis file contains the initial parameters with which to set up the node. | ||
| It contains the following fields: | ||
| - Genesis time |
There was a problem hiding this comment.
Same as previous comments -- would be good to link this to a reference doc rather than just listing everything here.
|
|
||
| #### Adding a Transaction | ||
|
|
||
| To import transactions into the `genesis.json` file, use the following command: |
There was a problem hiding this comment.
Link to the doc that shows how to created a transaction and direct the output to a file?
There was a problem hiding this comment.
Can we remove this tutorial from the docs/ folder and keep some documentation in the gno.land/cmd/gnoland/README.md?
Let's focus on providing the best tutorials for developers who want to write contracts. Gnodev is the way to go at the moment. Running custom Gnoland nodes is an advanced case that we prefer not to simplify for now.
|
@zivkovicmilos it might be useful to bring some of this to README in |
Description
This PR adds a page on
gnolandin the Getting Started section, which covers all commands available in this binary, as requested per #2127.It also audits all of the subcommands, and fixes some wrong command and flag descriptions.
Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description