Skip to content

Commit 31e5ea3

Browse files
authored
Merge pull request #570 from jrafanie/fix-grammar
Fix grammar and typos
2 parents b4d8a3d + 09953f3 commit 31e5ea3

11 files changed

+65
-65
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
* [Architecture](architecture.md)
3939
* [Opening custom URLs via Custom Buttons and Automate](automate_url_open.md)
4040
* [Report data API](ui/report_data_api.md)
41-
* [Remote Consoles](/remote_consoles.md)
41+
* [Remote Consoles](remote_consoles.md)
4242
* [REST API](http://manageiq.org/docs/api)
43-
* [Service UI Skinning](/service_ui/skinning.md)
43+
* [Service UI Skinning](service_ui/skinning.md)
4444
* [Shared react component API](ui/register_react_component.md)
4545
* [Working with Amazon AWS Config service](providers/amazon_aws_config.md)
4646

automate_url_open.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ Create custom button with Automate method:
3434
vm.external_url = "https://www.google.com"
3535
3636
```
37-
*important: use URL including the protocol (https) or the browser will ignore the request*
37+
*Important: Use URL including the protocol (https) or the browser will ignore the request*
3838

39-
*also disable URL pop-up blocking in your browser to make this work*
39+
*Also disable URL pop-up blocking in your browser to make this work*
4040

4141
Automation -> Automate -> Customization -> Buttons
4242

43-
Create a new button for VMs with "Open Url" checked and either w/ or w/o a "Dialog" and "Request" has to be `TestOpenUrl`
43+
Create a new button for VMs with "Open Url" checked and either with or without a "Dialog" and "Request" has to be `TestOpenUrl`
4444

4545
Go to VM summary page and click the new button.
4646

coding_style_and_standards.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ maintained by the ManageIQ team.
1717
## High Level Guidelines
1818

1919
* Be consistent.
20-
* These guides describes general guidelines to follow for new code.
20+
* These guides describe general guidelines to follow for new code.
2121
For existing code, stay consistent with the conventions of the code you
2222
are changing.
2323
* Prefer readability over performance and conciseness when the performance
@@ -238,7 +238,7 @@ already pushed them before.
238238

239239
* Reword/squashing/reordering a commit
240240

241-
To modify with recent commit in current branch, first do
241+
To modify recent commits in current branch, first do
242242
`git rebase -i origin branch-name`.
243243
To modify a specific commit, use `git rebase -i SOME_COMMIT_ID^` instead.
244244
git will popup a vi window to let you do modification on commits, press
@@ -251,7 +251,7 @@ already pushed them before.
251251

252252
* Squashing commits
253253

254-
Change the `pick` before the commit you want to squach to `squash` and edit
254+
Change the `pick` before the commit you want to squash to `squash` and edit
255255
the commit message after squash in a following popup vi window. A commit
256256
will be squashed with its previous commit.
257257

developer_setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ ManageIQ requires a memcached instance for session caching and a PostgreSQL data
114114

115115
Skip ahead to "Start the service"
116116

117-
2. Start the service
117+
3. Start the service
118118

119119
| | |
120120
| ---------- | --- |
@@ -248,9 +248,9 @@ bundle exec rails console
248248
simulate_queue_worker
249249
```
250250
251-
## macOS AirDrop & Handoff listens on port 5000
251+
## macOS AirDrop & Handoff Listens on Port 5000
252252
253-
If you run workers like we do on appliances using `ruby lib/workers/bin/evm_server.rb` remote console workers will try to bind to port 5000. This can fail on macOS with:
253+
If you run workers like we do on appliances using `ruby lib/workers/bin/evm_server.rb`, remote console workers will try to bind to port 5000. This can fail on macOS with:
254254
255255
```
256256
Address already in use - bind(2) for "0.0.0.0" port 5000

external_auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# External Authentication (httpd)
22

3-
- [Development with an OIDC server](./external_auth/oidc)
4-
- [Development with an IPA server](./external_auth/ipa)
3+
- [Development with an OIDC server](./external_auth/oidc.md)
4+
- [Development with an IPA server](./external_auth/ipa.md)

i18n.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ The following gettext routines are supported in Ruby and HAML sources:
4343
* [rubydoc](http://www.rubydoc.info/gems/gettext/GetText#N_-instance_method)
4444
* `n_(msgid, msgid_plural, n)` – returns either translated `msgid` or its translated plural form (`msgid_plural`) depending on `n`, a number determining the count (i.e. number above 1 means plural form)
4545
* [rubydoc](http://www.rubydoc.info/gems/gettext/GetText#ngettext-instance_method)
46-
* `s_(msgid, seperator = "|")` – translates `msgid`, but if there are no localized text, it returns a last part of `msgid` separated by `separator` (`|` by default)
46+
* `s_(msgid, separator = "|")` – translates `msgid`, but if there is no localized text, it returns a last part of `msgid` separated by `separator` (`|` by default)
4747
* [rubydoc](http://www.rubydoc.info/gems/gettext/GetText#sgettext-instance_method)
48-
* `ns_(msgid, msgid_plural, n, seperator = "|")` – similar to the `n_()`, but if there is no localized text, it returns a last part of `msgid` separated by `separator`.
48+
* `ns_(msgid, msgid_plural, n, separator = "|")` – similar to the `n_()`, but if there is no localized text, it returns a last part of `msgid` separated by `separator`.
4949
* [rubydoc](http://www.rubydoc.info/gems/gettext/GetText#ngettext-instance_method)
5050

5151
### JavaScript
@@ -145,8 +145,8 @@ The above should correctly be:
145145

146146
```html
147147
<span>
148-
<span ng=if="magicVaiable" translate>It's there</span>
149-
<span ng=if="!magicVariable" translate>It's not there</span>
148+
<span ng-if="magicVariable" translate>It's there</span>
149+
<span ng-if="!magicVariable" translate>It's not there</span>
150150
</span>
151151
```
152152

labels.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,43 @@ Below are charts describing all of the common labels and colors across the Manag
44

55
Color | Hex | Description
66
--- | --- | ---
7-
![](https://dummyimage.com/100x20/ee0701&amp;text=+) | `#ee0701` | Scope - Bugs
8-
![](https://dummyimage.com/100x20/84b6eb&amp;text=+) | `#84b6eb` | Scope - Enhancement
9-
![](https://dummyimage.com/100x20/bfe5bf&amp;text=+)![](https://dummyimage.com/100x20/bcf5db&amp;text=+) | `#bfe5bf``#bcf5db` | Scope - Testing and tools: "test", "developer", "tools"
10-
![](https://dummyimage.com/100x20/fef2c0&amp;text=+)![](https://dummyimage.com/100x20/e99695&amp;text=+) ![](https://dummyimage.com/100x20/fbca04&amp;text=+)![](https://dummyimage.com/100x20/ff7619&amp;text=+) | `#fef2c0``#e99695``#fbca04``#ff7619` | Scope - Other: "cleanup", "performance", "refactoring", "technical debt"
11-
![](https://dummyimage.com/100x20/0e8a16&amp;text=+) | `#0e8a16` | Positive statuses: "help wanted", "verified"
12-
![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | Negative statuses: "duplicate", "notabug", "stale", "unmergeable", "wip", "wontfix"
13-
![](https://dummyimage.com/100x20/cc317c&amp;text=+) | `#cc317c` | Questions and discussions: "question"
14-
![](https://dummyimage.com/100x20/5319e7&amp;text=+) | `#5319e7` | Component: Repo specific labels that categorize what parts of the application are being changed. See the repos for specifics.
15-
![](https://dummyimage.com/100x20/d4c5f9&amp;text=+) | `#d4c5f9` | Alternate component: A secondary, repo specific categorization (e.g. in manageiq-ui-classic, dark purple represents a specific UI tab being changed, whereas light purple is used for general components like toolbars or buttons)
16-
![](https://dummyimage.com/100x20/b4a8d1&amp;text=+) | `#b4a8d1` | Special component: A component that requires more careful handling and possibly a specific reviewer or merger. Right now this is only "dependencies" and "sql migration".
17-
![](https://dummyimage.com/100x20/000000&amp;text=+)![](https://dummyimage.com/100x20/555555&amp;text=+) ![](https://dummyimage.com/100x20/dddddd&amp;text=+) | `#000000``#555555``#dddddd` | Backporting and release: "blocker", "fine/yes", "fine/no", "darga/yes", "darga/no", etc. The darkest color is for the most recent release, the middle color is the release before that, and the lightest color is for any release older than that.
7+
![](https://dummyimage.com/100x20/ee0701&text=+) | `#ee0701` | Scope - Bugs
8+
![](https://dummyimage.com/100x20/84b6eb&text=+) | `#84b6eb` | Scope - Enhancement
9+
![](https://dummyimage.com/100x20/bfe5bf&text=+)![](https://dummyimage.com/100x20/bcf5db&text=+) | `#bfe5bf` `#bcf5db` | Scope - Testing and tools: "test", "developer", "tools"
10+
![](https://dummyimage.com/100x20/fef2c0&text=+)![](https://dummyimage.com/100x20/e99695&text=+) ![](https://dummyimage.com/100x20/fbca04&text=+)![](https://dummyimage.com/100x20/ff7619&text=+) | `#fef2c0` `#e99695` `#fbca04` `#ff7619` | Scope - Other: "cleanup", "performance", "refactoring", "technical debt"
11+
![](https://dummyimage.com/100x20/0e8a16&text=+) | `#0e8a16` | Positive statuses: "help wanted", "verified"
12+
![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | Negative statuses: "duplicate", "notabug", "stale", "unmergeable", "wip", "wontfix"
13+
![](https://dummyimage.com/100x20/cc317c&text=+) | `#cc317c` | Questions and discussions: "question"
14+
![](https://dummyimage.com/100x20/5319e7&text=+) | `#5319e7` | Component: Repo specific labels that categorize what parts of the application are being changed. See the repos for specifics.
15+
![](https://dummyimage.com/100x20/d4c5f9&text=+) | `#d4c5f9` | Alternate component: A secondary, repo specific categorization (e.g. in manageiq-ui-classic, dark purple represents a specific UI tab being changed, whereas light purple is used for general components like toolbars or buttons)
16+
![](https://dummyimage.com/100x20/b4a8d1&text=+) | `#b4a8d1` | Special component: A component that requires more careful handling and possibly a specific reviewer or merger. Right now this is only "dependencies" and "sql migration".
17+
![](https://dummyimage.com/100x20/000000&text=+)![](https://dummyimage.com/100x20/555555&text=+) ![](https://dummyimage.com/100x20/dddddd&text=+) | `#000000` `#555555` `#dddddd` | Backporting and release: "blocker", "fine/yes", "fine/no", "darga/yes", "darga/no", etc. The darkest color is for the most recent release, the middle color is the release before that, and the lightest color is for any release older than that.
1818

1919
### Common labels
2020

2121
Label | Color | Hex | Description
2222
--- | --- | --- | ---
23-
blocker | ![](https://dummyimage.com/100x20/000000&amp;text=+) | `#000000` | Blocker for the next release.
24-
bug | ![](https://dummyimage.com/100x20/ee0701&amp;text=+) | `#ee0701` | A bug.
25-
bug/sporadic test failure | ![](https://dummyimage.com/100x20/ee0701&amp;text=+) | `#ee0701` | A bug that manifests as test failures in an unpredictable way.
26-
cleanup | ![](https://dummyimage.com/100x20/fef2c0&amp;text=+) | `#fef2c0` | Changes only making the code cleaner and that do not change how the code works nor the outputs produced (e.g. rubocop or eslint changes).
27-
dependencies | ![](https://dummyimage.com/100x20/b4a8d1&amp;text=+) | `#b4a8d1` | Changes that affect dependencies, such as gem changes.
28-
developer | ![](https://dummyimage.com/100x20/bcf5db&amp;text=+) | `#bcf5db` | Changes that affect developers only, including non-customer-facing tools (e.g. changes to bin/setup)
29-
documentation | ![](https://dummyimage.com/100x20/d4c5f9&amp;text=+) | `#d4c5f9` | Changes to documentation only (e.g. README.md).
30-
duplicate | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The issue is a duplicate. When applied, the duplicate issue should be referenced in a comment.
31-
enhancement | ![](https://dummyimage.com/100x20/84b6eb&amp;text=+) | `#84b6eb` | An enhancement.
32-
help wanted | ![](https://dummyimage.com/100x20/0e8a16&amp;text=+) | `#0e8a16` | An issue that could be handled by anyone, even new members of the community.
33-
internationalization | ![](https://dummyimage.com/100x20/d4c5f9&amp;text=+) | `#d4c5f9` | Changes that are for internationalization only (e.g. updating the *.po gettext files).
34-
notabug | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The issue is not a bug as reported or not reproducible. When applied the issue should be closed.
35-
performance | ![](https://dummyimage.com/100x20/e99695&amp;text=+) | `#e99695` | Changes that are for performance improvements only.
36-
pinned | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The issue will not be marked by [**@miq-bot**](https://github.com/miq-bot) with the stale label.
37-
question | ![](https://dummyimage.com/100x20/cc317c&amp;text=+) | `#cc317c` | Issues that are just questions. When the question is resolved, the label should be changed and/or the issue should be closed.
38-
refactoring | ![](https://dummyimage.com/100x20/fbca04&amp;text=+) | `#fbca04` | Changes in the way the code works internally without changing the output produced. Contrast to "cleanup".
39-
stale | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The issue is old and hasn't had activity in 6 months. This label will be automatically applied by [**@miq-bot**](https://github.com/miq-bot).
40-
technical debt | ![](https://dummyimage.com/100x20/ff7619&amp;text=+) | `#ff7619` | Changes that remove or significantly update old unused code and/or dependencies.
41-
test | ![](https://dummyimage.com/100x20/bfe5bf&amp;text=+) | `#bfe5bf` | Changes to test code only.
42-
tools | ![](https://dummyimage.com/100x20/bcf5db&amp;text=+) | `#bcf5db` | Changes to customer-facing tools (e.g. tools/prune_metrics.rb). Contrast to "developer".
43-
unmergeable | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The PR is unmergeable. This label is automatically applied and removed by [**@miq-bot**](https://github.com/miq-bot).
44-
verified | ![](https://dummyimage.com/100x20/0e8a16&amp;text=+) | `#0e8a16` | The bug issue was reviewed and is verified to have the problem stated and a PR should be created. This label is not necessary on a bug PR.
45-
wip | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The PR is a WIP. This label is automatically applied and removed by [**@miq-bot**](https://github.com/miq-bot) based on PR title having "[WIP]" or not.
46-
wontfix | ![](https://dummyimage.com/100x20/eeeeee&amp;text=+) | `#eeeeee` | The issue will not be fixed or otherwise handled. When applied, the issue should be closed.
23+
blocker | ![](https://dummyimage.com/100x20/000000&text=+) | `#000000` | Blocker for the next release.
24+
bug | ![](https://dummyimage.com/100x20/ee0701&text=+) | `#ee0701` | A bug.
25+
bug/sporadic test failure | ![](https://dummyimage.com/100x20/ee0701&text=+) | `#ee0701` | A bug that manifests as test failures in an unpredictable way.
26+
cleanup | ![](https://dummyimage.com/100x20/fef2c0&text=+) | `#fef2c0` | Changes only making the code cleaner and that do not change how the code works nor the outputs produced (e.g. rubocop or eslint changes).
27+
dependencies | ![](https://dummyimage.com/100x20/b4a8d1&text=+) | `#b4a8d1` | Changes that affect dependencies, such as gem changes.
28+
developer | ![](https://dummyimage.com/100x20/bcf5db&text=+) | `#bcf5db` | Changes that affect developers only, including non-customer-facing tools (e.g. changes to bin/setup)
29+
documentation | ![](https://dummyimage.com/100x20/d4c5f9&text=+) | `#d4c5f9` | Changes to documentation only (e.g. README.md).
30+
duplicate | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The issue is a duplicate. When applied, the duplicate issue should be referenced in a comment.
31+
enhancement | ![](https://dummyimage.com/100x20/84b6eb&text=+) | `#84b6eb` | An enhancement.
32+
help wanted | ![](https://dummyimage.com/100x20/0e8a16&text=+) | `#0e8a16` | An issue that could be handled by anyone, even new members of the community.
33+
internationalization | ![](https://dummyimage.com/100x20/d4c5f9&text=+) | `#d4c5f9` | Changes that are for internationalization only (e.g. updating the *.po gettext files).
34+
notabug | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The issue is not a bug as reported or not reproducible. When applied the issue should be closed.
35+
performance | ![](https://dummyimage.com/100x20/e99695&text=+) | `#e99695` | Changes that are for performance improvements only.
36+
pinned | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The issue will not be marked by [**@miq-bot**](https://github.com/miq-bot) with the stale label.
37+
question | ![](https://dummyimage.com/100x20/cc317c&text=+) | `#cc317c` | Issues that are just questions. When the question is resolved, the label should be changed and/or the issue should be closed.
38+
refactoring | ![](https://dummyimage.com/100x20/fbca04&text=+) | `#fbca04` | Changes in the way the code works internally without changing the output produced. Contrast to "cleanup".
39+
stale | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The issue is old and hasn't had activity in 6 months. This label will be automatically applied by [**@miq-bot**](https://github.com/miq-bot).
40+
technical debt | ![](https://dummyimage.com/100x20/ff7619&text=+) | `#ff7619` | Changes that remove or significantly update old unused code and/or dependencies.
41+
test | ![](https://dummyimage.com/100x20/bfe5bf&text=+) | `#bfe5bf` | Changes to test code only.
42+
tools | ![](https://dummyimage.com/100x20/bcf5db&text=+) | `#bcf5db` | Changes to customer-facing tools (e.g. tools/prune_metrics.rb). Contrast to "developer".
43+
unmergeable | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The PR is unmergeable. This label is automatically applied and removed by [**@miq-bot**](https://github.com/miq-bot).
44+
verified | ![](https://dummyimage.com/100x20/0e8a16&text=+) | `#0e8a16` | The bug issue was reviewed and is verified to have the problem stated and a PR should be created. This label is not necessary on a bug PR.
45+
wip | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The PR is a WIP. This label is automatically applied and removed by [**@miq-bot**](https://github.com/miq-bot) based on PR title having "[WIP]" or not.
46+
wontfix | ![](https://dummyimage.com/100x20/eeeeee&text=+) | `#eeeeee` | The issue will not be fixed or otherwise handled. When applied, the issue should be closed.

logical_replication_migrations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Introduction
44

55
ManageIQ uses logical replication to provide central administrative functions over objects in other
6-
database regions. In order to do this, postgresql's logical replication is used to setup
6+
database regions. In order to do this, PostgreSQL's logical replication is used to set up
77
publications for specific tables in remote regions and subscriptions for each in the central or
88
global region.
99

@@ -21,7 +21,7 @@ This logic is what we're trying to test and verify.
2121

2222
## Pre-requisites
2323

24-
This was tested with 3 nightly appliances. They were setup to be at the Jansa codebase with
24+
This was tested with 3 nightly appliances. They were set up to be at the Jansa codebase with
2525
replication. The appliances were then migrated to kasparov. This document could be used for
2626
different branches or tags.
2727

@@ -105,7 +105,7 @@ Substitute XXX for the region number of this appliance:
105105

106106
## Configure replication for jansa
107107

108-
* Region 1 and 2:
108+
* Region 1 and 2:
109109
* These will be remotes, meaning they will "publish" the tables to be replicated:
110110

111111
```
@@ -118,12 +118,12 @@ Substitute XXX for the region number of this appliance:
118118
* The commands below will:
119119
* Provide the other regions' connection information
120120
* Create the subscription for each remote region
121-
121+
122122
```
123123
bin/rails c
124124
```
125125

126-
Subsitute the proper values below:
126+
Substitute the proper values below:
127127

128128
```
129129
$ require 'miq_pglogical'
@@ -137,7 +137,7 @@ Substitute XXX for the region number of this appliance:
137137
MiqPglogical.save_global_region([sub1, sub2], [])
138138
```
139139

140-
Now, replication can verified before moving on.
140+
Now, replication can be verified before moving on.
141141

142142
On the global:
143143

0 commit comments

Comments
 (0)