docs: fix typos and improve clarity in documentation files #3367
Conversation
This file contains hidden or 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
pinebit
reviewed
Nov 11, 2024
pinebit
requested changes
Nov 11, 2024
Collaborator
pinebit
left a comment
pinebit
left a comment
There was a problem hiding this comment.
One minor change is requested to complete this work. Thank you!
Contributor
Author
|
@pinebit Accepted your comment and reverted the changes back. Thank you for the clarification ! I indeed made a mistake. |
pinebit
approved these changes
Nov 11, 2024
Collaborator
pinebit
left a comment
pinebit
left a comment
There was a problem hiding this comment.
Thank you for the contribution!
pinebit
changed the title
pinebit
reviewed
Nov 11, 2024
|
|
||
| All metrics contain the following labels, so they are omitted from the table below: | ||
| - `cluster_hash`: The cluster lock hash uniquely identifying the cluster. | ||
| - `clustter_name`: The cluster lock name. |
Collaborator
There was a problem hiding this comment.
@futreall metrics.md is auto-generated from the source code.
To resolve the build failure, you will need to update markdown_internal_test.go line 87:
charon/cmd/markdown_internal_test.go
Line 87 in 9151aa0
This will make the build passing as the change will match the changes you made to metrics.md.
Thank you!
|
Contributor
Author
|
@pinebit I fixed everything, thanks! |
pinebit
added
the
merge when ready
KaloyanTanev
pushed a commit
that referenced
this pull request
Nov 19, 2024
This PR addresses minor typos, formatting issues, and enhances clarity in the following documentation files: - **branching.md**: Fixed typographical errors and improved clarity in descriptions of branching and release models. - **contributing.md**: Corrected link formatting issues, spelling mistakes, and clarified language in contributing guidelines. - **dkg.md**: Fixed typographical errors and improved sentence structure for better readability. - **metrics.md**: Corrected typo in metric label name. These changes improve the overall readability and accuracy of the documentation, ensuring that users and contributors have clearer instructions and information. category: docs ticket: none
Merged
obol-bulldozer bot
pushed a commit
that referenced
this pull request
Nov 20, 2024
Cherry-picked commits for v1.2-rc1. **Test command** - Add cluster lock and definition files to test peers [#3368](#3368) - Beacon node simulation [#3361](#3361) - General UX [#3370](#3370) - Create real blocks with MEV test [#3378](#3378) - Version check on beacon tests [#3379](#3379) - Rename test performance to test infra [#3380](#3380) - Output file improvements [#3384](#3384) - Custom number of validators for beacon node simulation [#3385](#3385) **Charon exit --all** - initial refactor [#3248](#3248) - add --all flag [#3272](#3272) - broadcast all exits [#3288](#3288) - fetch all exits [#3291](#3291) - enable exit all [#3296](#3296) - add custom testnet flags (to enable kurtosis testing) [#3317](#3317) - improve logging and error handling [#3347](#3347) - increase default Obol API timeout [#3353](#3353) **Misc** - Log leader index [#3334](#3334) - Add third Charon relay [#3227](#3227) - Fix promrated network overview stats [#3234](#3234) - Harden threshold parameter checks [#3242](#3242), [#3297](#3297) - Dependabot to bump only patch versions for our BLS library [#3352](#3352) - Optimize Dockerfile [#3281](#3281) **Tests / pipelines** - Fix flaky tests [#3309](#3309), [#3316](#3316), [#3332](#3332) - Disable intrange linter [#3282](#3282) - Create automate PR for release [#3310](#3310) - Use minor versions in pipelines [#3321](#3321) - Fix trigger-dispatch for release [#3351](#3351) [#3381](#3381) - Fix linter [#3307](#3307) (partially) **Docs** - Launchpad link broken [#3231](#3231) - Docs typos [#3236](#3236) [#3367](#3367) [#3369](#3369) All of the rest are tens of PRs with simple version bumps across the stack. category: misc ticket: none
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR addresses minor typos, formatting issues, and enhances clarity in the following documentation files:
These changes improve the overall readability and accuracy of the documentation, ensuring that users and contributors have clearer instructions and information.
category: docs
ticket: none