Merge pull request #16 from PagerDuty/fix/documentation-typos

fix: documentation typos

Author: João Glória

docs/advanced/configure-api-url.md

@@ -21,7 +21,7 @@ pagerDuty:
 ```
 
 !!! note
-    **PagerDuty accounts based in Europe use a different URL** so you need to override it here if that is your case.
+    **PagerDuty accounts based in Europe use a different URL** so you need to override it here if that applies to you.
 
     - EU-based accounts: 'https://api.eu.pagerduty.com'
     - US-based accounts: 'https://api.pagerduty.com'

docs/advanced/configure-events-url.md

@@ -21,8 +21,8 @@ pagerDuty:
 ```
 
 !!! note
-    **PagerDuty accounts based in Europe use a different URL** so you need to override it here if that is your case.
+    **PagerDuty accounts based in Europe use a different URL** so you need to override it here if that applies to you.
 
-    The correct url can be found in the Backstage integration page for your service on the PagerDuty console.
+    The correct URL can be found in the Backstage integration page for your service on the PagerDuty console.
 
     ![integration-events-api-url](../images/create-backstage-service-integration.png)

docs/advanced/configure-service-dependency-sync.md

@@ -1,15 +1,15 @@
 # Configure service dependency sync
 
-The PagerDuty plugin allows users, that use Backstage are their service catalog, to sync the dependencies automatically to the corresponding PagerDuty services.
+The PagerDuty plugin allows users who use Backstage as their service catalog to sync the dependencies automatically to the corresponding PagerDuty services.
 
-This feature is very powerfull for users that want to leverage [PagerDuty Status Pages](https://www.pagerduty.com/platform/business-ops/status-pages/) properly but are limited by the fact that they don't have service dependencies configured in PagerDuty. With this feature, the plugin will do this automatically for you.
+This feature is very powerful for users that want to leverage [PagerDuty Status Pages](https://www.pagerduty.com/platform/business-ops/status-pages/) properly but are limited by the fact that they don't have service dependencies configured in PagerDuty. With this feature, the plugin will do this automatically for you.
 
 !!! note
     Only the Backstage entities that have corresponding services in PagerDuty will get their service dependencies mapped. This feature is powered by the `CatalogProcessor` and therefore if you make changes on your Backstage entity configuration they will, in time, be mapped to PagerDuty.
 
-    These changes might not reflect immediatelly because the `CatalogProcessor` runs on a schedule and the plugin doesn't have control over that. Backstage admins can configure the frequency in which the entities are processed.
+    These changes might not reflect immediately because the `CatalogProcessor` runs on a schedule and the plugin doesn't have control over that. Backstage admins can configure the frequency at which the entities are processed.
 
-This feature is **disabled** by default but can easily be enabled on the PagerDuty advanced configuration page. If you haven't enabled it yet you can do so by following the instructions in [here](/backstage-plugin-docs/advanced/service-entity-mapping/#adding-the-pagerdutypage-component).
+This feature is **disabled** by default but can easily be enabled on the PagerDuty advanced configuration page. If you haven't enabled it yet you can do so by following the instructions [here](/backstage-plugin-docs/advanced/service-entity-mapping/#adding-the-pagerdutypage-component).
 
 ![dependency-sync-strategy](../images/dependency-sync-strategy.png)
 
@@ -23,4 +23,4 @@ Here you can choose:
 !!! note
     The syncing mechanism will overwrite all services on the destination so use this mechanism carefully.
 
-    **Example:** You set Backstage as your main source and you already have service dependencies in PagerDuty. Those will be overwritten has Backstage is now configured as the source of thruth.
+    **Example:** You set Backstage as your main source and you already have service dependencies in PagerDuty. Those will be overwritten as Backstage is now configured as the source of truth.

docs/advanced/create-service-software-template.md

@@ -15,7 +15,7 @@ By doing so, it enables and configures the PagerDuty Card provided by the fronte
 yarn --cwd packages/backend add @pagerduty/backstage-plugin-scaffolder-actions # (1)!
 ```
 
-1. This command adds `@pagerduty/backstage-plugin-scaffolder` package to the `packages/backend` folder because it is a backend module.
+1. This command adds the `@pagerduty/backstage-plugin-scaffolder` package to the `packages/backend` folder because it is a backend module.
 
 ## Adding the custom action to the project
 
@@ -25,7 +25,7 @@ You can add the custom action to the project in two different ways. Using the **
 
 Backstage Scaffolder capabilities can be extended with custom actions that support Software Templates. For that to happen you need to update `packages/backend/src/plugins/scaffolder.ts` and add custom actions.
 
-Now, the list of scaffolder actions cannot be appended so you need re-create it and append your custom action. Otherwise all actions will be replaced just with yours.
+Now, the list of scaffolder actions cannot be appended to, so you need to re-create it and append your custom action. Otherwise all actions will be replaced just with yours.
 
 ```typescript
 
@@ -71,11 +71,11 @@ export default async function createPlugin(
 }
 ```
 
-This step registers the custom action with the Scaffolder and allows it to be used in the Software template which you will configure on next step.
+This step registers the custom action with the Scaffolder and allows it to be used in the Software template which you will configure in the next step.
 
 ### New backend system
 
-Backstage's new backend system simplifies the configuration of backend plugins and requires less code to setup plugins. To add the PagerDuty scaffolder actions to your Backstage application add the following in `packages/backend/src/index.ts`.
+Backstage's new backend system simplifies the configuration of backend plugins and requires less code to set up plugins. To add the PagerDuty scaffolder actions to your Backstage application add the following in `packages/backend/src/index.ts`.
 
 ```typescript
 backend.add(import('@pagerduty/backstage-plugin-scaffolder-actions'));
@@ -86,11 +86,11 @@ backend.add(import('@pagerduty/backstage-plugin-scaffolder-actions'));
 Software Templates can be simple or complex depending on the practices you are trying to standardize across your teams. Here, we provide a simple example of a template that requests basic information for a Backstage service and augments that with information relevant for creating the service in PagerDuty.
 
 !!! note
-    We assume you have an `examples/template/content` folder which is automatically create when you use `npx @backstage/create-app` to create your Backstage project.
+    We assume you have an `examples/template/content` folder which is automatically created when you use `npx @backstage/create-app` to create your Backstage project.
 
 ### Create project configuration file
 
-In your `examples/template/content` folder you should create `catalog-info.yaml` file if you don't have one already. Update its content to something like this:
+In your `examples/template/content` folder you should create `catalog-info.yaml` file if you don't have one already. Update its contents to something like this:
 
 ```yaml
 apiVersion: backstage.io/v1alpha1
@@ -107,10 +107,10 @@ spec:
   owner: guests
 ```
 
-In the software template we will either replace the values for the `integration-key`, `service-id`, `account` and `name` or completely remove the parameters from the configuration.
+In the software template, we will either replace the values for the `integration-key`, `service-id`, `account`, and `name`, or completely remove the parameters from the configuration.
 
 !!! note
-    You don't need to use this exact template but to automate the configuration for the PagerDuty Card you need to have at least the `integration-key` or the `service-id` parameters.
+    You don't need to use this exact template but to automate the configuration for the PagerDuty Card, you need to have at least the `integration-key` or the `service-id` parameter.
 
 ### Create the Software Template
 
@@ -131,7 +131,7 @@ Once all the information is provided by the user we will:
 !!! note
     For the following template to work, you need to configure the `apiToken` in `app-config.yaml` file. If you haven't done so, follow the steps in [Configure Backend plugin API credentials](/backstage-plugin-docs/getting-started/backstage/#optional-configure-backend-plugin-api-credentials)
 
-    **Note:** If you don't setup this property in your configuration, the backend plugin will fail to start.
+    **Note:** If you don't set up this property in your configuration, the backend plugin will fail to start.
 
 !!! note
     The UI component that allows users to select the *Escalation Policy* when creating a new service in PagerDuty depends on an open source component. For the template to work properly please install it before.
@@ -154,7 +154,7 @@ Once all the information is provided by the user we will:
       </ScaffolderFieldExtensions>
     </Route>
     ```
-Once all requirements are in-place, create a `template.yaml` file under `examples/template` and copy the following code in there.
+Once all requirements are in place, create a `template.yaml` file under `examples/template` and copy the following code into it.
 
 ```yaml
 apiVersion: scaffolder.backstage.io/v1beta3
@@ -268,7 +268,7 @@ spec:
 
 1. Open source dropdown component from `@roadiehq` that queries data from a local API
 2. Options for the dropdown component
-3. The local api exposed by the PagerDuty backend plugin that retrieves a list of key/value pairs
+3. The local API exposed by the PagerDuty backend plugin that retrieves a list of key/value pairs
 4. This UI field is optional. If you want to enforce a specific method you can just set the value in the backend component.
 5. This parameter is optional. You can enforce a specific method by choosing 'intelligent', 'time' or 'content_based'. If not defined, no alert grouping will be configured.
    **[Requires AIOps](https://www.pagerduty.com/platform/aiops/).**

docs/advanced/enable-read-only-mode.md

@@ -1,12 +1,12 @@
 # Enable read-only mode
 
-The PagerDuty plugin allows users to create incidents directly from Backstage. This feature is enabled by default but you can choose to disable it.
+The PagerDuty plugin allows users to create incidents directly from Backstage. This feature is enabled by default, but you can choose to disable it.
 
 ![create-incident-button](../images/create-incident-button.png)
 
 ## Component read-only mode
 
-To suppress the rendering of the actionable incident creation button, the `PagerDutyCard` can be instantiated in `readOnly` mode as shown below.
+To suppress the rendering of the actionable incident creation button, the `PagerDutyCard` can be instantiated in `readOnly` mode, as shown below.
 
 ```html
 <EntityPagerDutyCard readOnly>

docs/advanced/hide-change-events.md

@@ -1,11 +1,11 @@
 # Hide change events
 
-The PagerDuty plugin allows users to view the recent changes made to components integrated with their PagerDuty service. This feature is enabled by default but you can choose to disable it.
+The PagerDuty plugin allows users to view the recent changes made to components integrated with their PagerDuty service. This feature is enabled by default, but you can choose to disable it.
 
 ![change-events-enabled](../images/change-events-enabled.png)
 
 !!! note
-    In order to ingest __change events__ in PagerDuty you need to have an AIOps license. If you don't have one, or you are missing the necessary permissions, you will see the following error.
+    In order to ingest __change events__ in PagerDuty you need to have an AIOps license. If you don't have one or are missing the necessary permissions, you will see the following error.
 
     ![aiops-license-missing](../images/change-events-forbidden.png)
 

docs/advanced/hide-oncall.md

@@ -1,6 +1,6 @@
 # Hide 'on-call' section
 
-The PagerDuty plugin allows users to view who is currently on-call for the escalation policy assigned to the service. This feature is enabled by default but you can choose to completely hide it.
+The PagerDuty plugin allows users to view who is currently on-call for the escalation policy assigned to the service. This feature is enabled by default, but you can choose to completely hide it.
 
 ![on-call-engineer](../images/view-oncall-engineers.png)
 

docs/advanced/homepage-component.md

@@ -1,4 +1,4 @@
-# Create an homepage component
+# Create a homepage component
 
 The most common use case for the plugin is to have an instance of the plugin in each service. Still, you might want to have multiple instances of the plugin in your homepage to provide visibility on multiple services at the same time.
 
@@ -27,10 +27,10 @@ export const homePage = (
 );
 ```
 
-This component requires you to specify the `service-id` and `integration-key` properties which allows for added flexibility.
+This component requires you to specify the `service-id` and `integration-key` properties which allow for added flexibility.
 
 !!! note
-    We are aware that this scenario is not ideal as the homepage will be full of different components and will be difficult to navigate on and for that reason we are working on a component that provides an aggregated view on multiple services.
+    We are aware that this scenario is not ideal as the homepage will be full of different components and will be difficult to navigate, and for that reason, we are working on a component that provides an aggregated view of multiple services.
 
-    Until we release that capability this is the best option if you want to provide visibility on multiple services on the same page.
+    Until we release that capability, this is the best option if you want to provide visibility into multiple services on the same page.
 

docs/advanced/service-entity-mapping.md

@@ -4,7 +4,7 @@ Users of PagerDuty plugin for Backstage are typically customers of PagerDuty tha
 
 This can of course be automated through the use of PagerDuty's APIs but it's still something that requires human effort and for some teams it is difficult to justify the investment.
 
-For that reason we create a `PagerDutyPage` component that is intended to be the single place for advanced configurations related to this plugin.
+For that reason, we created a `PagerDutyPage` component that is intended to be the single place for advanced configurations related to this plugin.
 
 > At this point in time the `PagerDutyPage` only allows Admins to map existing PagerDuty services to Backstage entities. Other features will be released in the future.
 
@@ -92,11 +92,11 @@ Now, Backstage Admins will have the option to configure the mapping between Page
 
 ## Mapping services to entities
 
-Once you navigate to the new `/pagerduty` route will see a page similar to the one below. On the table you will see a list of all your PagerDuty services, it's current mapping and the mapping status.
+Once you navigate to the new `/pagerduty` route will see a page similar to the one below. On the table you will see a list of all your PagerDuty services, their current mapping, and the mapping status.
 
 ![service-entity-mapping](../images/service-entity-mapping.png)
 
-To define the mapping between existing PagerDuty services and Backstage entities you need to select the edit option on the right. Once you do so, a new modal screen will pop-up. Here, you can choose from a list of available Backstage entities that you want to map to the PagerDuty service.
+To define the mapping between existing PagerDuty services and Backstage entities you need to select the edit option on the right. Once you do so, a new modal screen will pop up. Here, you can choose from a list of available Backstage entities that you want to map to the PagerDuty service.
 
 !!! warning
     Currently we only support 1:1 mapping between PagerDuty services and Backstage entities due to a limitation on the `PagerDutyCard` that only supports one service at a time. There is work in progress to overcome this limitation.
@@ -113,7 +113,7 @@ Mappings defined on this page are not persisted to source code but instead kept
 - **Out of Sync:** The configurations in the database and the configuration file do not match. In this occasion, the values from the database will take precedence as they are considered to be overrides.
 - **Not Mapped:** The PagerDuty service is not mapped to any Backstage entity.
 
-With this information the user can chose whether to manually persist the override to the source code and therefore ensure the configuration is in sync.
+With this information, the user can choose whether to manually persist the override to the source code and, therefore, ensure the configuration is in sync.
 
 !!! note
     We are evaluating an option to automatically create a PR in the source repo for the Backstage entity to ease the process of ensuring that configurations are in sync. Still, this feature is not available yet.