Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

[docs][Release/2.1.x] Update to how to and command ref #10290

Merged
merged 13 commits into from
May 4, 2021

Conversation

halsaphi
Copy link
Contributor

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:

  • Documentation
  • Stability bug fix
  • Other
  • Other - special case

Testing Changes

Select ANY that apply:

  • New Tests
  • Existing Tests
  • Test Framework
  • CI System
  • Other

Consensus Changes

  • Consensus Changes

API Changes

  • API Changes

Documentation Additions

  • Documentation Additions

Copy link
Contributor

@lparisc lparisc left a 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.
Copy link
Contributor

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.

Copy link
Contributor Author

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.
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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

Copy link
Contributor Author

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.
Copy link
Contributor

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.
Copy link
Contributor

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
Copy link
Contributor

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.`
Copy link
Contributor

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.

@halsaphi halsaphi merged commit 40a96af into release/2.1.x May 4, 2021
@halsaphi halsaphi deleted the release/2.1.x-howtos-ph branch May 4, 2021 05:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants