-
Notifications
You must be signed in to change notification settings - Fork 3.7k
[docs][Release/2.1.x] Update to how to and command ref #10290
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few suggestions and identified a few typos.
|
||
Acquire RAM for contract deployment, database tables, and other blockchain resources | ||
## Overview | ||
This guide provides instructions on how to buy RAM for an EOSIO blockchain account using the cleos CLI tool. RAM is a system resource and is used to store smart contract state and account information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cleos CLI tool -> `cleos`
How about:
RAM is a system resource used to store blockchain state such as smart contract data and account information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
|
||
## Before you begin | ||
Before you follow the step, make sure you fulfill the following items: | ||
The example uses cleos CLI tool to buy RAM for the alice account. The alice account pays for the RAM and the alice@active permisssion authorizes the transaction. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cleos CLI tool -> `cleos`
[[info | Note]] | ||
| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. | ||
| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos comand line tool and the keosd key store or wallet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cleos tool -> `cleos`
The phrase "or wallet" is not accurate. Consider simplifying to:
... will also install the `cleos` and `keosd` command-line tools.
| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos tool. | ||
| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos comand line tool and the keosd key store or wallet. | ||
* You have access to a blockchain and the `eosio.system` reference contract from [`eosio.contracts`](https://github.com/EOSIO/eosio.contracts) repository is deployed and used to manage system resources. | ||
* You have an EOSIO account and access to the account private key. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
account private key -> account's private key
| The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos comand line tool and the keosd key store or wallet. | ||
* You have access to a blockchain and the `eosio.system` reference contract from [`eosio.contracts`](https://github.com/EOSIO/eosio.contracts) repository is deployed and used to manage system resources. | ||
* You have an EOSIO account and access to the account private key. | ||
* You have sufficient [token allocated](how-to-transfer-an-eosio.token-token.md) to your account. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
token allocated -> tokens allocated
## Requirements | ||
* Install the currently supported version of `cleos.` | ||
[[info | Note]] | The cleos tool is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos comand line tool and the keosd key store or wallet. | ||
* You have access to a blockchain. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a blockchain -> an EOSIO blockchain
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
* Install the currently supported version of `cleos` and `keosd`. | ||
[[info | Note]] | ||
| The `cleos` tool and `keosd` wallet is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos comand line tool and the keosd key store or wallet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cleos tool -> `cleos`
The phrase "or wallet" is not accurate. Consider simplifying to:
... will also install the `cleos` and `keosd` command-line tools.
* Install the currently supported version of `cleos` and `keosd`. | ||
[[info | Note]] | ||
| The `cleos` tool and `keosd` wallet is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the cleos comand line tool and the keosd key store or wallet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is bundled -> are bundled
keosd
is not a wallet. Consider simplifying to:
The `cleos` tool and `keosd` wallet is bundled -> `cleos` and `keosd` are bundled
The phrase "or wallet" is not accurate. Consider simplifying to:
... will also install the `cleos` and `keosd` command-line tools.
``` | ||
|
||
The command asks for the private key |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command asks for the private key -> The command asks for the private key. Enter it:
``` | ||
|
||
2. Import a private key to a named wallet. The wallet must be `open` and `unlocked.` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are backticks in `open` and `unlocked` necessary? These are not system names or identifiers. If you want to emphasize you can use bold or italics.
Change Description
Update how to docs :
buy ram
update account keys
connect to a network
connect to a keosd
Update command ref docs :
cleos system buyram
cleos create key
cleos wallet import
cleos set account
cleos get account
Change Type
Select ONE:
Testing Changes
Select ANY that apply:
Consensus Changes
API Changes
Documentation Additions