Skip to content

Commit 8bb4bef

Browse files
ndokosportante
authored andcommitted
Fix typos, grammar in *.md files
Clean up some incorrect statements as well, mostly by deleting them.
1 parent f0c9aa0 commit 8bb4bef

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ https://github.com/distributed-system-analysis/pbench/milestones).
6767

6868
Below are some simple steps for setting up a development environment for
6969
working with the Pbench code base. For more detailed instructions on the
70-
workflow and process of contributing code to Pbench, refere to the [Guidelines
70+
workflow and process of contributing code to Pbench, refer to the [Guidelines
7171
for Contributing](doc/CONTRIBUTING.md).
7272

7373
### Getting the Code
@@ -85,17 +85,17 @@ execute:
8585
* `jenkins/run jenkins/tox -r --current-env -e jenkins-pytests`
8686
* `jenkins/run jenkins/tox -r --current-env -e jenkins-unittests`
8787

88-
The above commands runs the tests in a Fedora-base container with all the
88+
The above commands run the tests in a Fedora-base container with all the
8989
proper packages installed.
9090

91-
If you want to run the Unit Tests outside of that environment, you need to
91+
If you want to run the unit tests outside of that environment, you need to
9292
install `tox` properly in your environment (Fedora/CentOS/RHEL):
9393

9494
```
9595
$ sudo dnf install -y perl-JSON python3-pip python3-tox
9696
```
9797

98-
Once tox is installed you can run the unittests (use `tox --listenvs` to see
98+
Once tox is installed you can run the unit tests (use `tox --listenvs` to see
9999
the full list); e.g.:
100100

101101
* `tox -e util-scripts` -- for agent/util-scripts tests

agent/tool-scripts/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ for executing all the "persistent" tools. Once the Tool Meister sub-system is
3232
up and running, this phase is started first (required), and is ended before
3333
the Tool Meister sub-system is shut down (required). The `pbench-init-tools`
3434
CLI interface begins the "persistent" tools phase, and the `pbench-end-tools`
35-
closes out the phase. More about "persistent" tools below.
35+
CLI interface closes out the phase. More about "persistent" tools below.
3636

3737
The second phase is for executing all the "transient" tools (described below).
3838
This phase must be started after the "persistent" tools phase begins, and must
@@ -109,7 +109,7 @@ post-processing at a later time:
109109
$
110110
$ pbench-end-tools
111111
$
112-
$ # All data has been collected, run the all the post-processing locally.
112+
$ # All data has been collected, run all the post-processing locally.
113113
$
114114
$ pbench-postprocess-tools
115115
$ pbench-postprocess-tools
@@ -132,15 +132,15 @@ those tools registered.
132132
### The `node-exporter` and `dcgm` Tools
133133

134134
The `node-exporter` and `dcgm` tool scripts provided in this directory are
135-
placeholders only in order for users to see them along side the other tools.
135+
placeholders only in order for users to see them alongside the other tools.
136136
The actual implementation of these tools is handled by the Tool Meister code
137137
directly.
138138

139139
## Transient Tools
140140

141141
A "transient" tool is one where the tool data capture happens on the host
142142
local to where the tool is running. All transient tools store their data
143-
locally as directed by its invoking Tool Meister. For Tool Meisters running
143+
locally as directed by their invoking Tool Meister. For Tool Meisters running
144144
on the same host where the caller is driving the benchmark (where
145145
`pbench-tool-meister-start` was invoked), the captured data is stored directly
146146
into the local `${benchmark_result_dir}` directory. Tool Meisters running on
@@ -177,7 +177,7 @@ handles the required steps for properly capturing all of the relevant data and
177177
meta-data for that tool. These scripts are stored in the "postprocess"
178178
sub-directory named `<tool>-stop-postprocess`. The `stop-postprocess` script
179179
is executed on the host running the tool, after that tool is stopped
180-
successfully, but before reporting back to the caller the tool has stopped.
180+
successfully, but before reporting back to the caller that the tool has stopped.
181181

182182
Similarly, each transient tool can also optionally provide a "postprocess"
183183
script which handles post-processing steps for the captured data to apply any
@@ -189,7 +189,7 @@ when the `pbench-postprocess-tools` script is invoked.
189189
In cases where your operating system distribution does not provide a package
190190
for installing the Prometheus `node_exporter` command, consider following the
191191
steps below on the hosts from which you want to collect Prometheus
192-
`node_exporter`, and/or refer to the `node_exporter` [GitHub source
192+
`node_exporter` data, and/or refer to the `node_exporter` [GitHub source
193193
repository](https://github.com/prometheus/node_exporter).
194194

195195
1. `wget https://github.com/prometheus/node_exporter/releases/download/v1.0.1/node_exporter-1.0.1.linux-amd64.tar.gz` (latest version, change version number as desired)

doc/CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ the report as well, and they have been updated accordingly.
6767
1. Write appropriate Pull Request Title stating the fix
6868
1. Use present tense (ex. Fixes, Changes, Fixing, Changing..)
6969
1. Reference the issue that the PR is fixing with **“Fixes #issue_number”** in the description
70-
1. Provide a detailed description (at least 50 - 70 characters) of the changes; if UI related, add screenshots or gif
70+
1. Provide a detailed description of the changes; if UI related, add screenshots
7171
1. Make sure that the branches can be automatically merged (otherwise rebase the PR with `master`) and then click the drop down next to, `Create pull request`, and select `Create draft pull request`
7272
![Image](https://lh5.googleusercontent.com/V14SjFhimKYF1fH6TXMfaoZtDCj2ZH0d9USqe8YHyn0xOOVYekiXtx2CwdOQbSvxWPB6JVEfi4jSM_mjkSMaaI7voQNYQ8gDWntMhzCMbj3wrK3H4eCSEsdVq_XP_aZMdb5h9xU4)
7373

7474
1. Assign the PR to yourself and add appropriate labels
75-
1. Add "**DO NOT MERGE**" label if the work is not needed to be merged or there is no agreement on the work yet
75+
1. Add "**DO NOT MERGE**" label if the work does not need to be merged or there is no agreement on the work yet
7676
1. Make sure to add Milestone to the PR to mention specific release
7777
1. Request for review once the work is ready for getting reviewed
7878
![Image](https://lh6.googleusercontent.com/iM-vaIsFQ8ew7vpNDUvmSY9MVjyTadTZkngdlQfo7qYe_QQuFSA8yZ_3P40fBdeNw6Q-lSJwDD59jfBoQgdNP3mGHPgrjVicsyGt8QkMMAaDYowHsIyAnukXsEiFPSOnYnrZyze3)
@@ -82,7 +82,6 @@ the report as well, and they have been updated accordingly.
8282
1. Make sure to add proper details to the Issue raised
8383
1. Upload screenshot(if possible) in dashboard issues
8484
1. Apply proper labels to the Issue
85-
1. Make sure to add Milestone and Project to the issue to mention specific release.
8685
1. Try to actively respond to the communication in case of comments in the same issue.
8786

8887
## Reviewing a pull request

0 commit comments

Comments
 (0)