fix: correct typos, improve consistency, and update URLs #4451
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replaced the outdated Twitter URL (https://twitter.com) with the updated x.com format (https://x.com) to align with the platform's rebranding.
- Changed "setup" to "set up" for proper verb usage. - Corrected "docker file" and "alice docker file" to "Dockerfile" to maintain consistency. - Removed extra space before "Datadog API key". - Fixed "initialises" to "initializes" (American English spelling). - Corrected spelling of "strategiey" to "strategy".
- Changed "initialises" to "initializes" (American English spelling). - Corrected "whats" to "what's". - Capitalized "Gossamer Testnet" for consistency. - Changed "finalisation" to "finalization" (American English spelling). - Fixed grammatical error by changing "extrinsics is used" to "extrinsics are used".
|
|
|
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #4451 +/- ##
===============================================
+ Coverage 50.51% 54.35% +3.84%
===============================================
Files 230 345 +115
Lines 29006 45806 +16800
===============================================
+ Hits 14653 24900 +10247
- Misses 12856 18651 +5795
- Partials 1497 2255 +758 |
EclesioMeloJunior
requested changes
Jan 14, 2025
devnet/README.md
Outdated
| @@ -27,7 +27,7 @@ docker-compose down | |||
|
|
|||
| ## Prometheus Datadog Integration | |||
|
|
|||
| All Prometheus metrics from the nodes are piped to Datadog. You can setup your own dashboard and add additional tags by modifying the Dockerfiles. Currently the metrics are prefixed with `gossamer.local.devnet` and are tagged (Prometheus label) with a `key` tag for `alice`, `bob`, and `charlie`. | |||
| All Prometheus metrics from the nodes are piped to Datadog. You can set up our own dashboard and add additional tags by modifying the Dockerfiles. Currently the metrics are prefixed with `gossamer.local.devnet` and are tagged (Prometheus label) with a `key` tag for `alice`, `bob`, and `charlie`. | |||
There was a problem hiding this comment.
Suggested change
| All Prometheus metrics from the nodes are piped to Datadog. You can set up our own dashboard and add additional tags by modifying the Dockerfiles. Currently the metrics are prefixed with `gossamer.local.devnet` and are tagged (Prometheus label) with a `key` tag for `alice`, `bob`, and `charlie`. | |
| All Prometheus metrics from the nodes are piped to Datadog. You can set up your own dashboard and add additional tags by modifying the Dockerfiles. Currently the metrics are prefixed with `gossamer.local.devnet` and are tagged (Prometheus label) with a `key` tag for `alice`, `bob`, and `charlie`. |
devnet/README.md
Outdated
| @@ -41,12 +41,12 @@ export $DD_API_KEY=YourKey | |||
|
|
|||
| ### Dockerfiles | |||
|
|
|||
| There are four Docker files used in the devnet. | |||
| There are four Dockerfile s used in the devnet. | |||
There was a problem hiding this comment.
Suggested change
| There are four Dockerfile s used in the devnet. | |
| There are four Dockerfiles used in the devnet. |
| @@ -48,7 +48,7 @@ type Service interface { | |||
|
|
|||
| ### Core Service | |||
|
|
|||
| The **core service** is responsible for block production and finalisation (consensus) and processing messages received from the **network service**; it initialises <a target="_blank" rel="noopener noreferrer" href="https://research.web3.foundation/en/latest/polkadot/BABE/Babe/">BABE</a> sessions and <a target="_blank" rel="noopener noreferrer" href="https://github.com/w3f/consensus/blob/master/pdf/grandpa.pdf">GRANDPA</a> rounds and validates blocks and transactions before committing them to the **state service**. | |||
| The **core service** is responsible for block production and finalization (consensus) and processing messages received from the **network service**; it initializes<a target="_blank" rel="noopener noreferrer" href="https://research.web3.foundation/en/latest/polkadot/BABE/Babe/">BABE</a> sessions and <a target="_blank" rel="noopener noreferrer" href="https://github.com/w3f/consensus/blob/master/pdf/grandpa.pdf">GRANDPA</a> rounds and validates blocks and transactions before committing them to the **state service**. | |||
There was a problem hiding this comment.
Suggested change
| The **core service** is responsible for block production and finalization (consensus) and processing messages received from the **network service**; it initializes<a target="_blank" rel="noopener noreferrer" href="https://research.web3.foundation/en/latest/polkadot/BABE/Babe/">BABE</a> sessions and <a target="_blank" rel="noopener noreferrer" href="https://github.com/w3f/consensus/blob/master/pdf/grandpa.pdf">GRANDPA</a> rounds and validates blocks and transactions before committing them to the **state service**. | |
| The **core service** is responsible for block production and finalization (consensus) and processing messages received from the **network service**; it initializes <a target="_blank" rel="noopener noreferrer" href="https://research.web3.foundation/en/latest/polkadot/BABE/Babe/">BABE</a> sessions and <a target="_blank" rel="noopener noreferrer" href="https://github.com/w3f/consensus/blob/master/pdf/grandpa.pdf">GRANDPA</a> rounds and validates blocks and transactions before committing them to the **state service**. |
|
Hey @sergeypanin1994 , thanks for your contribution. Are you planning to address the latest comments from Eclesio? let me know in case we need to close this PR as stale |
Fixed. Sorry for the wait. |
|
@sergeypanin1994 there is 2 more comments, can you address them? |
|
I corrected the mistake |
|
Is everything okay? |
Hey @sergeypanin1994 everything appears ok, will merge anytime soon. Thank you for you contributions. If you are interested in future contributions please join our discord https://discord.gg/N7aaw676. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix: correct typos, improve consistency, and update URLs