Skip to content

Commit 71961da

Browse files
author
ManageIQ Bot
committed
1 parent 3b6b382 commit 71961da

12 files changed

+299
-299
lines changed

docs/guides/README.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -522,9 +522,9 @@ <h3 id="technical-documentation">Technical documentation</h3>
522522
<li><a href="architecture">Architecture</a></li>
523523
<li><a href="automate_url_open">Opening custom URLs via Custom Buttons and Automate</a></li>
524524
<li><a href="ui/report_data_api">Report data API</a></li>
525-
<li><a href="/docs/guides/remote_consoles">Remote Consoles</a></li>
525+
<li><a href="remote_consoles">Remote Consoles</a></li>
526526
<li><a href="http://manageiq.org/docs/api">REST API</a></li>
527-
<li><a href="/docs/guides/service_ui/skinning">Service UI Skinning</a></li>
527+
<li><a href="service_ui/skinning">Service UI Skinning</a></li>
528528
<li><a href="ui/register_react_component">Shared react component API</a></li>
529529
<li><a href="providers/amazon_aws_config">Working with Amazon AWS Config service</a></li>
530530
</ul>

docs/guides/automate_url_open.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,13 +509,13 @@ <h4 id="steps">Steps</h4>
509509
vm.external_url = "https://www.google.com"
510510

511511
</code></pre></div></div>
512-
<p><em>important: use URL including the protocol (https) or the browser will ignore the request</em></p>
512+
<p><em>Important: Use URL including the protocol (https) or the browser will ignore the request</em></p>
513513

514-
<p><em>also disable URL pop-up blocking in your browser to make this work</em></p>
514+
<p><em>Also disable URL pop-up blocking in your browser to make this work</em></p>
515515

516516
<p>Automation -&gt; Automate -&gt; Customization -&gt; Buttons</p>
517517

518-
<p>Create a new button for VMs with “Open Url” checked and either w/ or w/o a “Dialog” and “Request” has to be <code class="language-plaintext highlighter-rouge">TestOpenUrl</code></p>
518+
<p>Create a new button for VMs with “Open Url” checked and either with or without a “Dialog” and “Request” has to be <code class="language-plaintext highlighter-rouge">TestOpenUrl</code></p>
519519

520520
<p>Go to VM summary page and click the new button.</p>
521521

docs/guides/coding_style_and_standards.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ <h2 id="high-level-guidelines">High Level Guidelines</h2>
496496

497497
<ul>
498498
<li>Be consistent.</li>
499-
<li>These guides describes general guidelines to follow for new code.
499+
<li>These guides describe general guidelines to follow for new code.
500500
For existing code, stay consistent with the conventions of the code you
501501
are changing.</li>
502502
<li>Prefer readability over performance and conciseness when the performance
@@ -755,7 +755,7 @@ <h2 id="git-how-to">Git how-to</h2>
755755
<li>
756756
<p>Reword/squashing/reordering a commit</p>
757757

758-
<p>To modify with recent commit in current branch, first do
758+
<p>To modify recent commits in current branch, first do
759759
<code class="language-plaintext highlighter-rouge">git rebase -i origin branch-name</code>.
760760
To modify a specific commit, use <code class="language-plaintext highlighter-rouge">git rebase -i SOME_COMMIT_ID^</code> instead.
761761
git will popup a vi window to let you do modification on commits, press
@@ -771,7 +771,7 @@ <h2 id="git-how-to">Git how-to</h2>
771771
<li>
772772
<p>Squashing commits</p>
773773

774-
<p>Change the <code class="language-plaintext highlighter-rouge">pick</code> before the commit you want to squach to <code class="language-plaintext highlighter-rouge">squash</code> and edit
774+
<p>Change the <code class="language-plaintext highlighter-rouge">pick</code> before the commit you want to squash to <code class="language-plaintext highlighter-rouge">squash</code> and edit
775775
the commit message after squash in a following popup vi window. A commit
776776
will be squashed with its previous commit.</p>
777777
</li>

docs/guides/developer_setup.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -948,9 +948,9 @@ <h2 id="start-manageiq">Start ManageIQ</h2>
948948
simulate_queue_worker
949949
</code></pre></div></div>
950950

951-
<h2 id="macos-airdrop--handoff-listens-on-port-5000">macOS AirDrop &amp; Handoff listens on port 5000</h2>
951+
<h2 id="macos-airdrop--handoff-listens-on-port-5000">macOS AirDrop &amp; Handoff Listens on Port 5000</h2>
952952

953-
<p>If you run workers like we do on appliances using <code class="language-plaintext highlighter-rouge">ruby lib/workers/bin/evm_server.rb</code> remote console workers will try to bind to port 5000. This can fail on macOS with:</p>
953+
<p>If you run workers like we do on appliances using <code class="language-plaintext highlighter-rouge">ruby lib/workers/bin/evm_server.rb</code>, remote console workers will try to bind to port 5000. This can fail on macOS with:</p>
954954

955955
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Address already in use - bind(2) for "0.0.0.0" port 5000
956956
</code></pre></div></div>

docs/guides/i18n.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -542,12 +542,12 @@ <h3 id="ruby--haml">Ruby / HAML</h3>
542542
<li><a href="http://www.rubydoc.info/gems/gettext/GetText#ngettext-instance_method">rubydoc</a></li>
543543
</ul>
544544
</li>
545-
<li><code class="language-plaintext highlighter-rouge">s_(msgid, seperator = "|")</code> – translates <code class="language-plaintext highlighter-rouge">msgid</code>, but if there are no localized text, it returns a last part of <code class="language-plaintext highlighter-rouge">msgid</code> separated by <code class="language-plaintext highlighter-rouge">separator</code> (<code class="language-plaintext highlighter-rouge">|</code> by default)
545+
<li><code class="language-plaintext highlighter-rouge">s_(msgid, separator = "|")</code> – translates <code class="language-plaintext highlighter-rouge">msgid</code>, but if there is no localized text, it returns a last part of <code class="language-plaintext highlighter-rouge">msgid</code> separated by <code class="language-plaintext highlighter-rouge">separator</code> (<code class="language-plaintext highlighter-rouge">|</code> by default)
546546
<ul>
547547
<li><a href="http://www.rubydoc.info/gems/gettext/GetText#sgettext-instance_method">rubydoc</a></li>
548548
</ul>
549549
</li>
550-
<li><code class="language-plaintext highlighter-rouge">ns_(msgid, msgid_plural, n, seperator = "|")</code> – similar to the <code class="language-plaintext highlighter-rouge">n_()</code>, but if there is no localized text, it returns a last part of <code class="language-plaintext highlighter-rouge">msgid</code> separated by <code class="language-plaintext highlighter-rouge">separator</code>.
550+
<li><code class="language-plaintext highlighter-rouge">ns_(msgid, msgid_plural, n, separator = "|")</code> – similar to the <code class="language-plaintext highlighter-rouge">n_()</code>, but if there is no localized text, it returns a last part of <code class="language-plaintext highlighter-rouge">msgid</code> separated by <code class="language-plaintext highlighter-rouge">separator</code>.
551551
<ul>
552552
<li><a href="http://www.rubydoc.info/gems/gettext/GetText#ngettext-instance_method">rubydoc</a></li>
553553
</ul>
@@ -655,8 +655,8 @@ <h4 id="caveats">Caveats</h4>
655655
<p>The above should correctly be:</p>
656656

657657
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;span&gt;</span>
658-
<span class="nt">&lt;span</span> <span class="na">ng=</span><span class="s">if="magicVaiable"</span> <span class="na">translate</span><span class="nt">&gt;</span>It's there<span class="nt">&lt;/span&gt;</span>
659-
<span class="nt">&lt;span</span> <span class="na">ng=</span><span class="s">if="!magicVariable"</span> <span class="na">translate</span><span class="nt">&gt;</span>It's not there<span class="nt">&lt;/span&gt;</span>
658+
<span class="nt">&lt;span</span> <span class="na">ng-if=</span><span class="s">"magicVariable"</span> <span class="na">translate</span><span class="nt">&gt;</span>It's there<span class="nt">&lt;/span&gt;</span>
659+
<span class="nt">&lt;span</span> <span class="na">ng-if=</span><span class="s">"!magicVariable"</span> <span class="na">translate</span><span class="nt">&gt;</span>It's not there<span class="nt">&lt;/span&gt;</span>
660660
<span class="nt">&lt;/span&gt;</span>
661661
</code></pre></div></div>
662662

docs/guides/labels.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -499,12 +499,12 @@ <h3 id="about-the-label-colors">About the label colors</h3>
499499
</tr>
500500
<tr>
501501
<td><img src="https://dummyimage.com/100x20/bfe5bf&amp;text=+" alt="" /><img src="https://dummyimage.com/100x20/bcf5db&amp;text=+" alt="" /></td>
502-
<td><code class="language-plaintext highlighter-rouge">#bfe5bf</code><code class="language-plaintext highlighter-rouge">#bcf5db</code></td>
502+
<td><code class="language-plaintext highlighter-rouge">#bfe5bf</code> <code class="language-plaintext highlighter-rouge">#bcf5db</code></td>
503503
<td>Scope - Testing and tools: “test”, “developer”, “tools”</td>
504504
</tr>
505505
<tr>
506506
<td><img src="https://dummyimage.com/100x20/fef2c0&amp;text=+" alt="" /><img src="https://dummyimage.com/100x20/e99695&amp;text=+" alt="" /> <img src="https://dummyimage.com/100x20/fbca04&amp;text=+" alt="" /><img src="https://dummyimage.com/100x20/ff7619&amp;text=+" alt="" /></td>
507-
<td><code class="language-plaintext highlighter-rouge">#fef2c0</code><code class="language-plaintext highlighter-rouge">#e99695</code><code class="language-plaintext highlighter-rouge">#fbca04</code><code class="language-plaintext highlighter-rouge">#ff7619</code></td>
507+
<td><code class="language-plaintext highlighter-rouge">#fef2c0</code> <code class="language-plaintext highlighter-rouge">#e99695</code> <code class="language-plaintext highlighter-rouge">#fbca04</code> <code class="language-plaintext highlighter-rouge">#ff7619</code></td>
508508
<td>Scope - Other: “cleanup”, “performance”, “refactoring”, “technical debt”</td>
509509
</tr>
510510
<tr>
@@ -539,7 +539,7 @@ <h3 id="about-the-label-colors">About the label colors</h3>
539539
</tr>
540540
<tr>
541541
<td><img src="https://dummyimage.com/100x20/000000&amp;text=+" alt="" /><img src="https://dummyimage.com/100x20/555555&amp;text=+" alt="" /> <img src="https://dummyimage.com/100x20/dddddd&amp;text=+" alt="" /></td>
542-
<td><code class="language-plaintext highlighter-rouge">#000000</code><code class="language-plaintext highlighter-rouge">#555555</code><code class="language-plaintext highlighter-rouge">#dddddd</code></td>
542+
<td><code class="language-plaintext highlighter-rouge">#000000</code> <code class="language-plaintext highlighter-rouge">#555555</code> <code class="language-plaintext highlighter-rouge">#dddddd</code></td>
543543
<td>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.</td>
544544
</tr>
545545
</tbody>

docs/guides/logical_replication_migrations.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ <h1 id="testing-logical-replication-with-migrations">Testing logical replication
479479
<h2 id="introduction">Introduction</h2>
480480

481481
<p>ManageIQ uses logical replication to provide central administrative functions over objects in other
482-
database regions. In order to do this, postgresql’s logical replication is used to setup
482+
database regions. In order to do this, PostgreSQL’s logical replication is used to set up
483483
publications for specific tables in remote regions and subscriptions for each in the central or
484484
global region.</p>
485485

@@ -497,7 +497,7 @@ <h2 id="introduction">Introduction</h2>
497497

498498
<h2 id="pre-requisites">Pre-requisites</h2>
499499

500-
<p>This was tested with 3 nightly appliances. They were setup to be at the Jansa codebase with
500+
<p>This was tested with 3 nightly appliances. They were set up to be at the Jansa codebase with
501501
replication. The appliances were then migrated to kasparov. This document could be used for
502502
different branches or tags.</p>
503503

@@ -609,7 +609,7 @@ <h2 id="configure-replication-for-jansa">Configure replication for jansa</h2>
609609
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bin/rails c
610610
</code></pre></div> </div>
611611

612-
<p>Subsitute the proper values below:</p>
612+
<p>Substitute the proper values below:</p>
613613

614614
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ require 'miq_pglogical'
615615
host1 = 'x.x.x.x'
@@ -624,7 +624,7 @@ <h2 id="configure-replication-for-jansa">Configure replication for jansa</h2>
624624
</li>
625625
</ul>
626626

627-
<p>Now, replication can verified before moving on.</p>
627+
<p>Now, replication can be verified before moving on.</p>
628628

629629
<p>On the global:</p>
630630

docs/guides/remote_consoles.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,13 +476,13 @@
476476

477477
<h3 id="remote-consoles">Remote Consoles</h3>
478478

479-
<p>Remote consoles allow you to access the screen of a VM through the browser. Each supported protocol has a its own Javascript client and they all connect to a common WebSocket endpoint. This endpoint is provided by the Rails application under <code class="language-plaintext highlighter-rouge">/ws/console</code> and in production it’s being served by the <code class="language-plaintext highlighter-rouge">RemoteConsoleWorker</code>. This worker runs a <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/remote_console/rack_server.rb"><code class="language-plaintext highlighter-rouge">RemoteConsole::RackServer</code></a> middleware as a web server and it’s responsible for proxying and translating between the remote console endpoint and the incoming WebSocket connections.</p>
479+
<p>Remote consoles allow you to access the screen of a VM through the browser. Each supported protocol has its own JavaScript client and they all connect to a common WebSocket endpoint. This endpoint is provided by the Rails application under <code class="language-plaintext highlighter-rouge">/ws/console</code> and in production it’s being served by the <code class="language-plaintext highlighter-rouge">RemoteConsoleWorker</code>. This worker runs a <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/remote_console/rack_server.rb"><code class="language-plaintext highlighter-rouge">RemoteConsole::RackServer</code></a> middleware as a web server and it’s responsible for proxying and translating between the remote console endpoint and the incoming WebSocket connections.</p>
480480

481481
<p>The server can also be mounted into the development setup of Rails by setting the <code class="language-plaintext highlighter-rouge">MOUNT_REMOTE_CONSOLE_PROXY</code> environment variable:</p>
482482
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">MOUNT_REMOTE_CONSOLE_PROXY</span><span class="o">=</span>1 bin/rails server
483483
</code></pre></div></div>
484484

485-
<p>The proxy is implemented using an event loop and the <a href="https://github.com/skateman/surro-gate">surro-gate</a> gem as the selector for testing the readiness of socket pairs. The translation is done using adapters that are available as subclasses of <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/remote_console/server_adapter.rb"><code class="language-plaintext highlighter-rouge">RemoteConsole::ServerAdapter</code></a> for WebSocket and <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/remote_console/client_adapter.rb"><code class="language-plaintext highlighter-rouge">RemoteConsole::ClientAdapter</code></a> for the client protocols. Implementing a new protocol requires to create a new subclass in and update the <code class="language-plaintext highlighter-rouge">.new</code> method in the related adapter to be able to select it based on the passed context.</p>
485+
<p>The proxy is implemented using an event loop and the <a href="https://github.com/skateman/surro-gate">surro-gate</a> gem as the selector for testing the readiness of socket pairs. The translation is done using adapters that are available as subclasses of <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/remote_console/server_adapter.rb"><code class="language-plaintext highlighter-rouge">RemoteConsole::ServerAdapter</code></a> for WebSocket and <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/remote_console/client_adapter.rb"><code class="language-plaintext highlighter-rouge">RemoteConsole::ClientAdapter</code></a> for the client protocols. Implementing a new protocol requires creating a new subclass and updating the <code class="language-plaintext highlighter-rouge">.new</code> method in the related adapter to be able to select it based on the passed context.</p>
486486

487487
<p>The VNC and SPICE consoles are supported out of the box and there is also support for WebMKS. However, due to licensing problems we are not allowed to ship the WebMKS assets. They can be retrieved from the VMware website after accepting the license agreement. Pasting the <code class="language-plaintext highlighter-rouge">webmks</code> folder with all the assets into the <code class="language-plaintext highlighter-rouge">public</code> folder in the core repo automatically enables the support for this console type.</p>
488488

docs/guides/reviewers_guidelines.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@
477477
<h1 id="reviewers-guidelines">Reviewer’s guidelines</h1>
478478

479479
<p>We have some technical debt that is continuously being refactored.
480-
However, it’s possible that someone is getting inspired by wrong pattern that still lays in the codebase.
480+
However, it’s possible that someone is getting inspired by wrong patterns that still lie in the codebase.
481481
In such case the reviewer might not be aware of <em>The Right Way</em> and approves the changes.</p>
482482

483483
<p>This can cause a significant growth in technical debt. As it is complicated to track all the ongoing refactoring approaches,
@@ -493,7 +493,7 @@ <h2 id="manageiqmanageiq-ui-classic">ManageIQ/manageiq-ui-classic</h2>
493493

494494
<h3 id="testing-rbac-on-checked-items">Testing RBAC on checked items</h3>
495495

496-
<p>Make sure, the introduced code is checking the permissions on items checked in UI.
496+
<p>Make sure the introduced code is checking the permissions on items checked in UI.
497497
There is a list of classes, that support RBAC check in <a href="https://github.com/ManageIQ/manageiq/blob/master/lib/rbac/filterer.rb#L8"><code class="language-plaintext highlighter-rouge">CLASSES_THAT_PARTICIPATE_IN_RBAC</code></a></p>
498498

499499
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># =====</span>
@@ -544,7 +544,7 @@ <h4 id="double-checking-loaded-records">Double checking loaded records</h4>
544544

545545
<p>In case that no records are found, the method raises an <code class="language-plaintext highlighter-rouge">ActiveRecord::RecordNotFound</code> exception.</p>
546546

547-
<p>That means the double checking the variable with loaded records is not necessary, and therefore can be removed.</p>
547+
<p>That means double checking the variable with loaded records is not necessary, and therefore can be removed.</p>
548548

549549
<div class="language-diff highlighter-rouge"><div class="highlight"><pre class="highlight"><code> scheds = find_records_with_rbac(MiqSchedule, checked_or_params)
550550
<span class="gd">- if scheds.empty?

docs/guides/vagrant_developer_vm.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ <h2 id="instructions">Instructions</h2>
504504
<p>Everything that is inside this folder will be copied into <code class="language-plaintext highlighter-rouge">/manageiq</code> in the VM</p>
505505
</li>
506506
<li>Clone the repo into your machine (i.e. in <code class="language-plaintext highlighter-rouge">~/Vagrant/manageiq-dev</code>)
507-
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ git clone https://github.com/ManageIQ/manageiq-vagrant-dev.git ~/Vagrant/manageiq-dev`
507+
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ git clone https://github.com/ManageIQ/manageiq-vagrant-dev.git ~/Vagrant/manageiq-dev
508508
</code></pre></div> </div>
509509
</li>
510510
<li>
@@ -529,7 +529,7 @@ <h2 id="instructions">Instructions</h2>
529529
<span class="nv">$ </span>vagrant halt <span class="c"># shutdown the VM</span>
530530
</code></pre></div> </div>
531531

532-
<p>Ports 3000 for the UI and 4000 for the API are forwared to your local machine, so you can access them through <a href="http://127.0.0.1:3000">http://127.0.0.1:3000</a> and <a href="http://127.0.0.1:4000">http://127.0.0.1:4000</a></p>
532+
<p>Ports 3000 for the UI and 4000 for the API are forwarded to your local machine, so you can access them through <a href="http://127.0.0.1:3000">http://127.0.0.1:3000</a> and <a href="http://127.0.0.1:4000">http://127.0.0.1:4000</a></p>
533533
</li>
534534
<li>
535535
<p>Developing</p>

0 commit comments

Comments
 (0)