Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

ReadMe followup for #2313 #2317

Merged
merged 2 commits into from
Mar 15, 2023
Merged

ReadMe followup for #2313 #2317

merged 2 commits into from
Mar 15, 2023

Conversation

skunert
Copy link
Contributor

@skunert skunert commented Mar 14, 2023

Some comments did not make it in time in #2313.

  • Lines are now approx. 100 characters long.
  • ran this through the spellchecker again and improved clarity.
  • Removed the comments in the code snippets, maybe was unnecessary to begin with, the text describes the options already
  • relaychain -> relay chain

@skunert skunert added A0-please_review Pull request needs code review. C1-low PR touches the given topic and has a low impact on builders. T0-node This PR/Issue is related to the topic “node”. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Mar 14, 2023
@skunert skunert requested review from davxy and a team March 14, 2023 17:35
@davxy davxy requested a review from a team March 14, 2023 18:55

### Zombienet
We use Zombienet to spin up networks for integration tests and local networks. Follow [these installation steps](https://github.com/paritytech/zombienet#requirements-by-provider) to set it up on your machine.
A simple network specification with two relay chain nodes and one collator is located at [zombienet/examples/small_network.toml](zombienet/examples/small_network.toml).
We use Zombienet to spin up networks for integration tests and local networks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We use Zombienet to spin up networks for integration tests and local networks.
Zombienet is used to spin up networks for integration tests and local networks.

A simple network specification with two relay chain nodes and one collator is located at [zombienet/examples/small_network.toml](zombienet/examples/small_network.toml).
We use Zombienet to spin up networks for integration tests and local networks.
Follow [these installation steps](https://github.com/paritytech/zombienet#requirements-by-provider)
to set it up on your machine. A simple network specification with two relay chain nodes and one collator is
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
to set it up on your machine. A simple network specification with two relay chain nodes and one collator is
to set it up on local machine. A simple network specification with two relay chain nodes and one collator is

@michalkucharczyk
Copy link
Contributor

michalkucharczyk commented Mar 14, 2023

minor: Matter of taste, I prefer impersonal forms in tech specs.

@skunert skunert added the B0-silent Changes should not be mentioned in any release notes label Mar 15, 2023
@skunert skunert merged commit 4036124 into paritytech:master Mar 15, 2023
ordian added a commit that referenced this pull request Mar 16, 2023
* master: (44 commits)
  Companion for #13287 (#2155)
  timestamp ci job logs (#2327)
  Release parachain host API v4 (#2325)
  Bump clap from 4.1.6 to 4.1.8 (#2272)
  Enabled `polkadot-parachain` build for `runtime-benchmarks`, e.g.: (#2324)
  Bump tokio from 1.25.0 to 1.26.0 (#2273)
  Bump async-trait from 0.1.64 to 0.1.66 (#2318)
  ReadMe followup for  #2313 (#2317)
  Fix runtime api import path (#2319)
  Update Westend collectives chainspec (#2311)
  README: Document usage of RPC node (#2313)
  Companion for paritytech/substrate#13592 (#2310)
  Update orchestra and metered-channel (#2304)
  Backport: Brigehub: Add in force upgrade xcm version (into master) (#2289)
  [Backport] version bumps from 9380 (#2309)
  Bump proc-macro2 from 1.0.50 to 1.0.52 (#2312)
  Remove use of trait Store (#2286)
  Companion for #13482 (#2303)
  add amforc bootnodes (#2246)
  Cleanup dependencies + dead code (#2302)
  ...
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit T0-node This PR/Issue is related to the topic “node”.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants