README editorial pass (mattermost-community#102)

Brightscout · Jun 28, 2023 · cced384 · cced384
1 parent 54aa9cf
commit cced384
Showing 1 changed file with 17 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -14,30 +14,29 @@ With the Confluence plugin, you can subscribe to a variety of events in Confluen
   - Confluence spaces, including those created, updated, deleted, and restored, and those with added comments.
   - Confluence pages, including those created, updated, deleted, restored, and those with added, deleted, or updated comments.
 
-## Admin Guide 
+## Admin guide 
 
 ### Prerequisites
 
 For Confluence Plugin, Mattermost server v5.19+ is required. Confluence Server version 7.x+ is supported. Confluence Data Center is not certified.
 
-### Install the Mattermost Plugin
+### Installation
 
 To get started, a plugin that is installed on the Mattermost Server is needed to receive messages from the Confluence server. The notifications route it to the correct channel based on subscriptions that are configured. 
 
-#### Install via Plugin Marketplace (Recommended)
+#### Marketplace installation (Recommended)
 
 1. In Mattermost, go to **Main Menu > Plugin Marketplace**.
-2. Search for "Confluence" or manually find the plugin from the list and click **Install**.
-3. After the plugin has downloaded and been installed, click the **Configure** button.
+2. Search for "Confluence" or manually find the plugin from the list and select **Install**.
+3. After the plugin has downloaded and been installed, select the **Configure** button.
 4. Go to **Plugins Marketplace > Confluence**. 
 
-    - Click the **Configure** button.
+    - Select the **Configure** button.
     - Generate a **Secret** for `Webhook Secret and Stats API Secret`.
 
-5. Go to the top of the screen and set **Enable Plugin** to `True` and then click **Save** to enable the plugin.
-
-#### (Alternative) Install via Manual Upload
+5. Go to the top of the screen and set **Enable Plugin** to `True` and then select **Save** to enable the plugin.
 
+#### Manual installation
 1. Go to the [releases page of this GitHub repositiory](https://github.com/mattermost/mattermost-plugin-confluence/releases/latest), and download the latest release for your Mattermost Server.
 2. Upload this file in the Mattermost **System Console > Plugins > Management** page to install the plugin.
 3. Configure the Plugin from **System Console > Plugins > Confluence**.
@@ -46,13 +45,13 @@ To get started, a plugin that is installed on the Mattermost Server is needed to
 
 Now, you'll need to configure your Confluence server to communicate with the plugin on the Mattermost Server. The instructions are different for Cloud vs Server/Data Center. 
 
-#### Set Up Confluence Server
+#### Set up Confluence Server
 
 To get started, type in `/confluence install server` in a Mattermost chat window.
 
 1. Download the [Mattermost for Confluence OBR file](https://github.com/mattermost/mattermost-for-confluence/releases) from the "Releases" tab in the Mattermost-Confluence plugin repository. Each release has some JVM files and an .OBR file.  Download it to your local computer. You will upload it to your Confluence server later in this process. 
 2. Log in as an Administrator on Confluence to configure the plugin.
-3. Create a new app in your Confluence Server by navigating to **Settings > Apps > Manage Apps**. For older versions of Confluence, navigate to **Administration > Applications > Add-ons > Manage add-ons**.
+3. Create a new app in your Confluence Server by going to **Settings > Apps > Manage Apps**. For older versions of Confluence, go to **Administration > Applications > Add-ons > Manage add-ons**.
 4. Choose **Settings** at the bottom of the page, enable development mode, and apply the changes. Development mode allows you to install apps from outside of the Atlassian Marketplace.
 5. Press **Upload app**.
 
@@ -62,20 +61,20 @@ To get started, type in `/confluence install server` in a Mattermost chat window
 7. Once the app is installed, press **Configure** to open the configuration page.
 8. In the **Webhook URL field**, enter the URL that is displayed after you typed `/confluence install server` - it is unique to your server. You'll need to copy/paste it from Mattermost into the **From this URL** field in Confluence. 
 9. Press **Save** to finish the setup.
-10. Navigate to **Settings > Apps > Manage Apps**.
+10. Go to **Settings > Apps > Manage Apps**.
 11. Choose **Settings** at the bottom of the page, enable development mode, and apply the change. Development mode allows you to install apps from outside of the Atlassian Marketplace.
 
     ![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/74422101/fa27854e-6305-4164-963f-a5692284bf95)
 
 12. Once installed, you will see the "Installed and ready to go!" message in Confluence.
 13. You can now go to Mattermost and type `/confluence subscribe` in the channel you want to get notified by Confluence.
 
-#### Set Up Confluence Cloud
+#### Set up Confluence Cloud
 
 To get started, type in `/confluence install cloud` in a Mattermost chat window.
 
 1. Log in as an Administrator on Confluence.
-2. Navigate to **Settings > Apps > Manage Apps**.
+2. Go to **Settings > Apps > Manage Apps**.
 3. Choose **Settings** at the bottom of the page, enable development mode, and apply the change. Development mode allows you to install apps from outside of the Atlassian Marketplace.
 
     ![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/74422101/34471b0f-e54d-476c-b843-bf71355b6831)
@@ -88,7 +87,7 @@ To get started, type in `/confluence install cloud` in a Mattermost chat window.
 6. Once installed, you will see the "Installed and ready to go!" message in Confluence.
 7. You can now go to Mattermost and type `/confluence subscribe` in the channel you want to get notified by Confluence.
 
-## Configure Notifications
+## Configure notifications
 
 ### /confluence subscribe
 
@@ -142,21 +141,21 @@ example: `/confluence unsubscribe "Project A Subscription"`.
 **Maintainer:** [@jfrerich](https://github.com/jfrerich)
 **Co-Maintainer:** [@levb](https://github.com/levb)
 
-### Platform & tools
+### Platform and tools
 
 - Make sure you have following components installed:
 
   - Go - v1.13 - [Getting Started](https://golang.org/doc/install)
     > **Note:** If you have installed Go to a custom location, make sure the `$GOROOT` variable is set properly. Refer [Installing to a custom location](https://golang.org/doc/install#install).
   - Make
 
-## Setting up CircleCI
+## Set up CircleCI
 
 Set up CircleCI to run the build job for each branch and build-and-release for each tag.
 
 1. Go to [CircleCI Dashboard](https://circleci.com/dashboard).
 2. In the top left, you will find the Org switcher. Select your Organisation.
-3. If this is your first project on CircleCI, go to the Projects page, click the **Add Projects** button, then click the **Set Up Project** button next to your project. You may also click **Start Building** to manually trigger your first build.
+3. If this is your first project on CircleCI, go to the Projects page, select the **Add Projects** button, then select the **Set Up Project** button next to your project. You may also select **Start Building** to manually trigger your first build.
 4. To manage GitHub releases using CircleCI, you need to add your github personal access token to your project's environment variables.
    - Follow the instructions [here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) to create a personal access token. For CircleCI releases, you would need the `repo` scope.
    - Add the environment variable to your project as `GITHUB_TOKEN` by following the instructions [here](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-project).