chore: typo fixes

README.md

@@ -75,9 +75,9 @@
 # Navigation
 In order for a page to appear on the left-hand navigation column, it needs to be
 listed in `_data/toc.yaml`.  Use the basename of the page (e.g. 'foo' if the
-page is 'foo.md') and insert it into YAML heirarchy under the appropriate
+page is 'foo.md') and insert it into YAML hierarchy under the appropriate
 project and appropriate topic.  If you forget to include your page in the
-heirarchy, Jekyll will issue a warning when it is rendering the site.
+hierarchy, Jekyll will issue a warning when it is rendering the site.
 
 # Deployment
 1. Submit your changes as a PR.  The GitHub Actions continuous integration hook

docs/candlepin/amqp.md

@@ -157,7 +157,7 @@ If you have set up a standalone qpid server, the ssl certificate can be found in
   $ sudo qpid-config --ssl-certificate=path/to/cert --ssl-key path/to/key -b amqps://localhost:5671 del exchange event
   ```
 
-* Create an excange.
+* Create an exchange.
 
   ```console
   $ sudo qpid-config --ssl-certificate=path/to/cert --ssl-key path/to/key -b amqps://localhost:5671 add exchange topic event --durable

docs/candlepin/api_version_design.md

@@ -133,7 +133,7 @@ Please add your questions and comments to the bottom with your username.
      it to be able to talk to _all_ versions. Candlepin, on the other hand, would need to speak to all versions of python-rhsm.
    * zeus: +1 new versions know how to talk to their version of candlepin. But the server needs to speak all versions (up to a point).
  * dgoodwin: What constitutes a new *version* of the API? Any behavioral change? Any release? Any major release?
-   * jbowes: if we can support minor api rev bumps that are backwards compatible (ie adding a new field onto a json struture makes the api 1.1, but 1.0 clients can still speak to it), then I'd 
+   * jbowes: if we can support minor api rev bumps that are backwards compatible (ie adding a new field onto a json structure makes the api 1.1, but 1.0 clients can still speak to it), then I'd 
      bump for any new feature. for major api revs, we'd bump whenever we have to make a change that old clients couldn't understand, for example a new certificate format.
  * dgoodwin: How do we maintain test coverage across all versions?
    * zeus: from a spec test perspective, this will involve adding NEW tests when we bump versions for an api method

docs/candlepin/artemis_jobs.md

@@ -25,7 +25,7 @@ be aware:
 
 This leaves the responsibility of timing, conversion and compatibility to Satellite's upgrade process
 or the manual upgrade process followed for non-standard deployments (i.e. hosted). However, this sounds
-worse than it acutally is: At the time of writing, both Satellite and hosted currently wait for manually
+worse than it actually is: At the time of writing, both Satellite and hosted currently wait for manually
 executed jobs to complete before performing an upgrade, most job configurations have only changed
 location, not value, and the API changes have been minimized or duplicated to avoid compatibility issues
 where possible.

docs/candlepin/autoattach.md

@@ -282,7 +282,7 @@ adjusting quantity to consume, starting at the minimum increment, up to max
 available, until the stack is compliant.  return a map of pool id to pool
 quantity for candlepin to interpret.
 
-### Accomodating Guests
+### Accommodating Guests
 When a guest attempts to Auto Attach, the host will first attempt to Auto Attach, with some significant changes:
 
 1. The host will be handed the guests list of installed products, and attempt to Auto Attach with these
@@ -303,7 +303,7 @@ Caveats:
 
   1. The quantity the guest will need is not considered, we only attempt to get
      a pool available. Usually the guest just needs one. But with issues like
-     one sub-pool per stack, trying to add more entitlements becomes noticably
+     one sub-pool per stack, trying to add more entitlements becomes noticeably
      more difficult.
 
 

docs/candlepin/batch_binding.md

@@ -4,7 +4,7 @@ title: Batch binding exact pools
 {% include toc.md %}
 
 ## Overview
-* Candlepin 2.0 provides a convinience API to bind a batch of exact pools by respective quantities. This document shows the usage and example responses of that API.
+* Candlepin 2.0 provides a convenience API to bind a batch of exact pools by respective quantities. This document shows the usage and example responses of that API.
 * Batch bind requests are asynchronous only.
 * The requests are atomic. If any of the pools and respective quantities requested fails for any reason ( including JavaScript validation ), the entire operation fails and none of the pools are consumed.
 
@@ -50,7 +50,7 @@ title: Batch binding exact pools
   url: GET https://localhost:8443/candlepin/jobs/bind_by_pool_1cfdedb3-05aa-444a-814a-aabc5afedba4?result_data=true
   ```
 
-## Succesful Response
+## Successful Response
 * Upon success, the `resultData` on the `JobStatus` enlists a `PoolIdAndQuantity` for each pool consumed with the respective quantity consumed
 
   ```text

docs/candlepin/caching.md

@@ -89,7 +89,7 @@ In Candlepin, we mainly cache `Product`/`Content` entities and all the collectio
 Very simplified view of when Hibernate uses 2LC can be summarized as follows:
 
  * When entity is looked up by its `Id` column
- * When entity is defiend as ManyToOne attribute and isn't referenced in the query (when the attribute is referenced in the query, Hibernate will usually issue a Sql Join to load the attribute value)
+ * When entity is defined as ManyToOne attribute and isn't referenced in the query (when the attribute is referenced in the query, Hibernate will usually issue a Sql Join to load the attribute value)
  * When persistent collection is cached (`Cache` annotation on the collection), the entities in that collection will be loaded from 2LC
  * A query is cached and the results are cached entities - this is quite obvious
  * When using old Hibernate Criteria - this is a bit odd, but when using old Hibernate Criteria, Hibernate is sometimes less proactive doing Sql Joins and instead it is loading associated relationship using separate selects. Which means you may get more cache hits
@@ -149,7 +149,7 @@ Even though `Product` is not taken from cache here, we are still getting benefit
  * Query for `OwnerProduct` entity and set `OwnerProduct.product` as EAGER with Fetch style SELECT
  * Query for `OwnerProduct` entity and then manually query for `Product` using its UUID
 
-Lets discuss the first option. Becuase we set `OwnerProduct.product` to LAZY, Hibernate is not going to join when we execute the query. Then, because `OwnerProduct.product` is a relationship that retrieves just one Product, Hibernate will utilize 2LC. The code might look like this:
+Lets discuss the first option. Because we set `OwnerProduct.product` to LAZY, Hibernate is not going to join when we execute the query. Then, because `OwnerProduct.product` is a relationship that retrieves just one Product, Hibernate will utilize 2LC. The code might look like this:
 
 ```
     public Product getProductByIdJpql(String ownerId, String productId) {

docs/candlepin/constraints.md

@@ -60,6 +60,6 @@ Could be based on unit of time, cpu cycles, any other criteria accessible.
 Draw down is probably best used for things like training. Here is a set number
 of hours or usage period. Once you have used it up, there is no more.
 
-## Cloud Subcriptions
+## Cloud Subscriptions
 Similar to quantity based, but the consumers are potentially shorted lived.
 This is similar to "Concurrent users" as a licensing model.

docs/candlepin/crl.md

@@ -184,7 +184,7 @@ performed when the caller first constructs the streaming reader:
    `seqLength` (the length of the *revokedCertificates* sequence).
 5. We are now within the *revokedCertificates* sequence.
 
-With the preliminary operations complete, we return the instatiated reader and
+With the preliminary operations complete, we return the instantiated reader and
 the caller can begin streaming sequences within *revokedCertificates* using the
 `next` method.  This method returns one revoked certificate sequence each time
 it is called.
@@ -213,7 +213,7 @@ The caller would need to pass in some type of memo object to the streaming
 reader when the reader is instantiated.  As the reader moves through the
 meta-data items in the *tbsCertList* during initialization, it would simply
 populate the memo object with the values.  The caller could then look in the
-memo object once the reader has finished instatiation.
+memo object once the reader has finished instantiation.
 
 Signature verification is more complex.  Since the signature algorithm used is
 required for the verification process and the algorithm information is towards

docs/candlepin/disable_autoattach.md

@@ -6,7 +6,7 @@ title: Disabling Auto Attach
 # Disabling Auto Attach For An Owner
 _This feature is available in both candlepin-0.9.54.11+ and candlepin-2.0.20+_
 
-Candlepin allows disabling the Auto Attach functionality, on a per Owner basis, to accomodate entitlement stability
+Candlepin allows disabling the Auto Attach functionality, on a per Owner basis, to accommodate entitlement stability
 for Consumers of an Owner/Organisation during subscription renewals and/or other maintenance.
 
 In many circumstances, Candlepin's Auto Attach functionality is not the greatest at selecting the most

docs/candlepin/dtos.md

@@ -107,7 +107,7 @@ Direct instantiation:
     this.modelTranslator = new StandardTranslator(...);
 ```
 
-Dependecy injection:
+Dependency injection:
 ```
     @Inject
     public MyResource(ModelTranslator modelTranslator) {
@@ -197,7 +197,7 @@ Similarly, the populate methods take a source object and a destination object, a
 object with data from the source object. Both methods have a overloaded definition which also accepts a
 model translator which can be used to translate nested objects within the source object.
 
-The overlapping nature of the translate and populate operations allows most object translator implementions to
+The overlapping nature of the translate and populate operations allows most object translator implementations to
 simply chain the translate operation into the populate operation rather than duplicate code. For example:
 
 ```

docs/candlepin/external_artemis_setup.md

@@ -4,7 +4,7 @@ title: Configuring A Remote Artemis Server
 {% include toc.md %}
 
 # Configuring A Remote Artemis Server
-By default, candlepin runs with an embedded Artemis server. Candlepin does however support running against a remote Artemis server. The following guide will walk you through installing a remote Artemis server with basic configuration. Because candlepin relys on very specific queues and addresses, it is not advised to mess with these configuration settings.
+By default, candlepin runs with an embedded Artemis server. Candlepin does however support running against a remote Artemis server. The following guide will walk you through installing a remote Artemis server with basic configuration. Because candlepin relies on very specific queues and addresses, it is not advised to mess with these configuration settings.
 
 ## Installing Artemis
 First, stop tomcat so that the embedded Artemis instance is shut down to avoid port conflicts.
@@ -52,7 +52,7 @@ sudo useradd artemis --home /var/lib/artemis
 sudo chown -R artemis:artemis /var/lib/artemis
 ```
 
-Setup an SELinux policy for the artemis service. In a temp directory, create an ***artemisservice.te*** file contining the following.
+Setup an SELinux policy for the artemis service. In a temp directory, create an ***artemisservice.te*** file containing the following.
 ```bash
 module artemisservice 1.0;
 
@@ -107,7 +107,7 @@ sudo systemctl start artemis
 sudo systemctl status artemis
 ```
 
-In a seperate terminal, tail and grep the logs to make sure that candlepin is running against the remote Artemis server when it starts.
+In a separate terminal, tail and grep the logs to make sure that candlepin is running against the remote Artemis server when it starts.
 
 ```bash
 tail -f /var/log/candlepin/candlepin.log  | grep "Candlepin will connect"

docs/candlepin/fail_fast.md

@@ -12,7 +12,7 @@ Fail Fast mechanism is a set of defensive measures that Candlepin automatically
 Fail Fast mechanism currently defends against problems with Qpid Broker. It uses feature called Suspend Mode to temporarily stop Candlepin's operations.
 
 ## Suspend Mode
-Candlepin can operate in two modes: NORMAL mode and SUSPEND mode. The NORMAL corresponds to standard Candlepin operation. SUSPEND mode is a state in which Candlepin stops responding to most of the requests. When in SUSPEND mode, Candlepin will return HTTP code 503. Also, all the scheduled jobs are suspended. The only available resoruce is `/status` endpoint. Thus, when in SUSPEND mode, clients cannot use Candlepin. The current mode of Candlepin can be discovered using `/status` endpoint. It is recommended that this endpoint is used for polling the Candlepin mode.
+Candlepin can operate in two modes: NORMAL mode and SUSPEND mode. The NORMAL corresponds to standard Candlepin operation. SUSPEND mode is a state in which Candlepin stops responding to most of the requests. When in SUSPEND mode, Candlepin will return HTTP code 503. Also, all the scheduled jobs are suspended. The only available resource is `/status` endpoint. Thus, when in SUSPEND mode, clients cannot use Candlepin. The current mode of Candlepin can be discovered using `/status` endpoint. It is recommended that this endpoint is used for polling the Candlepin mode.
 
 The feature is enabled by default and can be controlled using config property `candlepin.suspend_mode_enabled`
 
@@ -55,4 +55,4 @@ The spec tests assume existence of special queue. To create it, it is necessary
 Qpid Management Framework is proprietary Qpid, message base, protocol. It is used to manage Qpid Broker and also to retrieve information about the broker. Candlepin uses QMF (implementation in `QpidQmf.java`) in order to figure out whether an exchange is flow stopped.
 
 ### Startup Check
-At the startup of Candlepin, Qpid QMF is used to check for the connectivity to the broker. If it is not CONNECTED, then Candlepin immediatelly fails and stops the startup. This behavior can be controlled by property `candlepin.amqp.qmf.startup_check_enabled`
+At the startup of Candlepin, Qpid QMF is used to check for the connectivity to the broker. If it is not CONNECTED, then Candlepin immediately fails and stops the startup. This behavior can be controlled by property `candlepin.amqp.qmf.startup_check_enabled`

docs/candlepin/glossary.md

@@ -29,7 +29,7 @@ Entitlement Pool
 You will also see the other terms used throughout the wiki
 
 Entitlement Certificate
-: By default, an x.509 certficate which represents you right to consume a subscription. This certificate can be used to access software.
+: By default, an x.509 certificate which represents you right to consume a subscription. This certificate can be used to access software.
 
 Identity Certificate
 : By default, an x.509 certificate which unique identifies a single consumer.

docs/candlepin/hibernate.md

@@ -197,7 +197,7 @@ So the complete test method now looks like this:
 ```
 {:.numbered}
 
-Given the refresh on line 09, you would expect the code will pass. It wont. Instead you will get [0] again. Now the problem why this code doesn't work is much more intricate. The implementation of on createEntitlement (our standard functional test prepare method) on line 6 is:
+Given the refresh on line 09, you would expect the code will pass. It won't. Instead you will get [0] again. Now the problem why this code doesn't work is much more intricate. The implementation of on createEntitlement (our standard functional test prepare method) on line 6 is:
 
 [6]
 

docs/candlepin/how_subscriptions_work.md

@@ -79,7 +79,7 @@ When a subscription object is imported, depending on the attributes of its main
 
 #### Derived Products
 
-Pools can also carry a "derived" product and provided products. This accomodates scenarios where the host is intended to get access to different (or no) content than the guests. The parent or primary pool will use the normal product and provided products on the subscription. However any derived or unmapped guest pools will flip to use the derived product and provided products instead of the normal set.
+Pools can also carry a "derived" product and provided products. This accommodates scenarios where the host is intended to get access to different (or no) content than the guests. The parent or primary pool will use the normal product and provided products on the subscription. However any derived or unmapped guest pools will flip to use the derived product and provided products instead of the normal set.
 
 ## Entitlements
 
@@ -106,7 +106,7 @@ Pools can also carry a "derived" product and provided products. This accomodates
 
 ## Exporting Subscriptions to a Downstream Candlepin Server
 
-Candlepin has been designed to allow for exporting subscriptions from a main/upstream Candlepin server for use in a standlone on-premises environment. (i.e. Katello, Satellite, SAM) This process involves a number of steps:
+Candlepin has been designed to allow for exporting subscriptions from a main/upstream Candlepin server for use in a standalone on-premises environment. (i.e. Katello, Satellite, SAM) This process involves a number of steps:
 
  1. A "distributor" consumer is created in the upstream candlepin server by some UI. (also sometimes referred to as a "Subscription Management Application")
  1. A user assigns entitlements to the distributor consumer for export in whatever quantities they wish to use downstream. Once assigned those are marked as consumed in the upstream server.

docs/candlepin/manifest_consumer_association.md

@@ -4,7 +4,7 @@ title: Manifest Consumer Association
 {% include toc.md %}
 
 # Manifest Consumer Association Design
-Katello neesds the ability to associate a given manifest with the distributor (consumer). The following information needs to be accessible.
+Katello needs the ability to associate a given manifest with the distributor (consumer). The following information needs to be accessible.
 
 * consumer uuid
 * consumer id cert pub/priv pair

docs/candlepin/manifest_export.md

@@ -5,7 +5,7 @@ title: Exporting A Manifest
 
 # Exporting A Manifest
 
-In order for a consumer to be exported, it must be manfest enabled. We refer to this type of consumer as a distributor. A consumer is considered to be a distributor if its ConsumerType defines 'manifest':true. Any entitlements attached to a distributor will be included in the manifest when it is exported.
+In order for a consumer to be exported, it must be manifest enabled. We refer to this type of consumer as a distributor. A consumer is considered to be a distributor if its ConsumerType defines 'manifest':true. Any entitlements attached to a distributor will be included in the manifest when it is exported.
 
 To export a manifest for a distributor, you use the [GET /consumers/:uuid/export/async]({{ site.url }}/swagger/?url=candlepin/swagger-2.0.13.json#!/owners/exportDataAsync){:target="_blank"} API. When the export request is made, candlepin will start an asynchronous job that will perform the export. When the job is complete, the job status will provide the details of how the export can be obtained using the [GET /consumers/:uuid/export/:export_id]({{ site.url }}/swagger/?url=candlepin/swagger-2.0.13.json#!/owners/downloadExistingExport){:target="_blank"} API.
 
@@ -76,7 +76,7 @@ A manifest file contains all of the data from the upstream candlepin required to
 
 Extracting a manifest file yields:
 
-- **consumer_export.zip:** An archive of the expored consumer data.
+- **consumer_export.zip:** An archive of the exported consumer data.
 - **signature:** The signature for the consumer_export.zip file.
 
 The contents of the consumer_export.zip file are as follows:

docs/candlepin/manifest_extensions.md

@@ -59,7 +59,7 @@ package org.candlepin.example;
 import com.google.inject.AbstractModule;
 
 /**
- * When overriding service implmentation, a custom guice module must be created. In this
+ * When overriding service implementation, a custom guice module must be created. In this
  * example, we simply bind the ExportExtensionAdapter interface to our custom extension
  * adapter class so that candlepin will inject our adapter whenever the interface is
  * injected.

docs/candlepin/manifest_import.md

@@ -57,7 +57,7 @@ $ curl -k -X POST -F "application/zip=@1dc9d30a-cb39-4155-8789-c6efb0061b42-expo
 }
 
 # Monitor the job status to see when the job has completed
-# and if it was successfull.
+# and if it was successful.
 $ curl -k -u USERNAME:PASSWORD https://localhost:8443/candlepin/jobs/import_8b018fd9-679a-4e2e-8704-2eac757b35a8?result_data=true
 {
   "id" : "import_8b018fd9-679a-4e2e-8704-2eac757b35a8",