John/docs

.gitignore

@@ -31,3 +31,5 @@ book.mobi
 
 .DS_Store
 *.swp
+
+site/

docs/docs/integration-ci-cd/bitrise.md

@@ -73,7 +73,7 @@ The lines following `content` are shell commands. You may create a shell script
     mq apps
 ```
 
-* `npm install mq-cli` installs the MQ CLI. See the [MQ CLI documentation](mq-cli/#Installation) for alternative installation commands.
+* `npm install mq-cli` installs the MQ CLI. See the [MQ CLI documentation](mq-cli.md#Installation) for alternative installation commands.
 
 * `mq login -a $API_KEY` will log you in using your API key.
 

docs/docs/integration-ci-cd/fastlane.md

@@ -48,7 +48,7 @@ mq upload -a $APP_ID -f $1
 mq apps
 ```
 
-* `npm install mq-cli` installs the MQ CLI. See the [MQ CLI documentation](mq-cli/#Installation) for alternative installation commands.
+* `npm install mq-cli` installs the MQ CLI. See the [MQ CLI documentation](mq-cli.md#Installation) for alternative installation commands.
 
 * `mq login -a $API_KEY` logs you in using your API key.
 

docs/docs/notifications/gitbot/features.md

@@ -6,8 +6,12 @@ When a pull request is opened or reopned, Gitbot will post to the pull request a
 
 ## Status Updates
 
-If Gitbot has been [configured correctly](getting-started/#setup), it will post updates from tests to the comments of a pull request.
+If Gitbot has been [configured correctly](getting-started.md#setup), it will post updates from tests to the comments of a pull request. These updates may also contain screenshots, visualizing the pages on which a test failed or succeeded.
 
 ## Future Features
 
-In the future, Gitbot could be smarter and capable of automatically testing your new app versions when they are, perhaps, in a pending pull request. Then, Gitbot could post testing updates to the comments of said pull request, thereby notifying you of any breaking bugs without you having to manually enter any pull request URLs.
+In the future, Gitbot could be smarter and capable of automatically testing your new app versions when they are, perhaps, in a pending pull request. Then, Gitbot could post testing updates to the comments of said pull request, thereby notifying you of any breaking bugs without you having to manually enter any pull request URLs.
+
+## Feature Request
+
+Do you have a request for a new feature? Open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues) with your feature request! Alternatively, you can send your feature request to <hello@moquality.com>.

docs/docs/notifications/gitbot/getting-started.md

@@ -8,7 +8,7 @@ MoQuality's services provide an invaluable advancement to QA testing, but those
 
 * GitHub accounts & respository: In order to use Gitbot, you will, of course, need to have created a [GitHub account](https://github.com/join) and a [repository](https://github.com/new).
 * MoQuality account: Gitbot will need to link your GitHub account to your MoQuality account, which you can create [here](https://app.moquality.com/signup).
-* MoQuality app: For the purpose of test status notifications for a new version of your app, ensure that you have already uploaded the first version of your app through the [MoQuality website](https://app.moquality.com/).
+* MoQuality app: For the purpose of receiving test status notifications for a new version of your app, ensure that you have already uploaded the first version of your app through the [MoQuality website](https://app.moquality.com/).
 
 ## Installation
 
@@ -24,4 +24,6 @@ Gitbot can be uninstalled by navigating to the `Integrations` tab of your [MoQua
 
 ## Troubleshooting
 
-If you encounter an error, please open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues). Alternatively, you can report your error to <hello@moquality.com>.
+### Undocumented Error
+
+If you encounter an error that is not documented, please open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues). Alternatively, you can report your error to <hello@moquality.com>.

docs/docs/notifications/ptbot/features.md

@@ -0,0 +1,17 @@
+# PTBot Features
+
+## Upload App Reminder
+
+When a story is in the `Delivered` state, that is, when the story is ready to be accepted or rejected, PTBot will post to the story a comment, reminding you to upload the new version of your app to MoQuality.
+
+## Status Updates
+
+If PTBot has been [configured correctly](getting-started.md#setup), it will post updates from tests to the comments of a story. These updates may also contain screenshots, visualizing the pages on which a test failed or succeeded.
+
+## Future Features
+
+In the future, PTBot could be capable of identifying links to a GitHub pull request in a Pivotal Tracker story. If the user has [configured Gitbot correctly](../../gitbot/getting-started), PTBot could automatically post updates to a GitHub pull request with only the URL to the Pivotal Tracker story, if the bot had been configured to do so.
+
+## Feature Request
+
+Do you have a request for a new feature? Open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues) with your feature request! Alternatively, you can send your feature request to <hello@moquality.com>.

docs/docs/notifications/ptbot/getting-started.md

@@ -0,0 +1,43 @@
+# Getting Started with PTBot
+
+## Introduction
+
+Pivotal Tracker is an agile project management tool that developers employ for maintaing project backlogs. Just as it is important to keep logs of new features and implementations, it is also essential to keep logs of the integrity of said features. MoQuality's Pivotal Tracker bot (PTBot) does this for you. When generating tests on MoQuality, you can simply add a link to a pivotal tracker story and PTBot will automatically post status updates in the comments of your story. To enable this integration, you need only to follow two simple steps.
+
+## Prerequisites
+
+* Pivotal Tracker account & project: In order to use PTBot, you will, of course, need to have created a [Pivotal Tracker account](https://www.pivotaltracker.com/signup/new) and a [project](https://www.pivotaltracker.com/help/articles/creating_a_project/).
+* MoQuality account: PTBot will need to link your Pivotal Tracker project to your MoQuality account, which you can create [here](https://app.moquality.com/signup).
+* MoQuality app: For the purpose of generating tests and receiving test status notifications, ensure that you have already uploaded the first version of your app through the [MoQuality website](https://app.moquality.com/).
+
+## Installation
+
+### Invite PTBot to Your Project
+
+PTBot is a Pivotal Tracker user, named `MoQuality Bot`. In order for PTBot to comment on a story, it must be a member of your Pivotal Tracker project. To invite PTBot, visit the `MEMBERS` tab on your project,
+
+![MEMBERS tab](ptbot-img/members_tab.png)
+
+press the `Invite People` button, and invite `bot@moquality.com` as a member of your project.
+
+![Inivitation page](ptbot-img/invitation_page.png)
+
+This will add PTBot to your project, enabling the bot to comment on stories.
+
+### Add a Webhook to Your Project
+
+Pivotal Tracker offers webhook support for projects. A [Pivotal Tracker project webhook](https://www.pivotaltracker.com/help/articles/activity_webhook/) is a location to which Pivotal tracker sends activity information when changes are made to a project. For instance, when a story's state is changed to `Delivered`, Pivotal Tracker will send JSON data, describing that change, to the project's webhooks. When PTBot's webhook is added to your project, PTBot can monitor a story's state to tell you when to upload a new version of your app to MoQuality. To add PTBot's webhook to your project, visit the `MORE` tab on your project, select the `Webhooks` page from the menu on the left, and add the following webhook URL to your project: `https://notifications-dot-moquality-inc.appspot.com/ptbot/events`
+
+![Webhook page](ptbot-img/webhook_page.png)
+
+## Setup
+
+To recieve testing updates in the comments of a story, enter your story's URL when you press the `Generate Tests` button on your MoQuality app's page. This will tell PTBot where to post status updates from those tests. You can also enter the story's URL on the test report's page. A story URL can be copied from Pivotal Tracker by expanding a story and clicking the chain symbol underneath a story's name.
+
+![Story configuration](ptbot-img/story_config.png)
+
+## Troubleshooting
+
+### Undocumented Error
+
+If you encounter an error that is not documented, please open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues). Alternatively, you can report your error to <hello@moquality.com>.

docs/docs/notifications/slackbot/features.md

@@ -57,4 +57,8 @@ Posts a private message as an attachment containing information about the MoQual
 
         **Usage**
 
-            /mq-user
+            /mq-user
+
+## Feature Request
+
+Do you have a request for a new feature? Open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues) with your feature request! Alternatively, you can send your feature request to <hello@moquality.com>.

docs/docs/notifications/slackbot/getting-started.md

@@ -16,16 +16,18 @@ Install Slackbot from your [MoQuality account page](https://app.moquality.com/ac
 
 ## Setup
 
-Once Slackbot is integrated with your workspace, your MoQuality and Slack accounts are linked. This means that you or anyone else in your workspace can invoke one of Slackbots many [Slash Commands](features/#slash commands). By typing `/mq` in your Slack workspace, you should see a list of the available Slash Commands.
+Once Slackbot is integrated with your workspace, your MoQuality and Slack accounts are linked. This means that you or anyone else in your workspace can invoke one of Slackbots many [Slash Commands](features.md#slash commands). By typing `/mq` in your Slack workspace, you should see a list of the available Slash Commands.
 
 ![Available Slash Commands](slackbot-img/available_slash_commands.png)
 
-The first Slash Command you may want to use is [`/mq-subscribe [app Id]`](features/#mq-subscribe). This command subscribes the authorized channel to test updates from the given MoQuality app. After subscribing the channel, Slackbot posts a public message as an attachment containing information about the subscription.
+The first Slash Command you may want to use is [`/mq-subscribe [app Id]`](features.md#mq-subscribe). This command subscribes the authorized channel to test updates from the given MoQuality app. After subscribing the channel, Slackbot posts a public message as an attachment containing information about the subscription.
 
 ## Uninstallation
 
 Slackbot can be uninstalled by navigating to the `Integrations` tab of your [MoQuality account page](https://app.moquality.com/account) and pressing the `X` on the top right of the Slack integration. This will direct you to Slackbot's configuration page, and at the bottom of said page is the `Remove app` button. By clicking that button, Slackbot will be uninstalled from your workspace and your MoQuality account will be delinked from your Slack account.
 
 ## Troubleshooting
 
-If you encounter an error, please open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues). Alternatively, you can report your error to <hello@moquality.com>.
+### Undocumented Error
+
+If you encounter an error that is not documented, please open an issue on our [public GitHub repository](https://github.com/moquality/devcenter/issues). Alternatively, you can report your error to <hello@moquality.com>.

docs/mkdocs.yml

@@ -72,6 +72,9 @@ nav:
     - Gitbot:
       - Getting Started: notifications/gitbot/getting-started.md
       - Features: notifications/gitbot/features.md
+    - Pivotal Tracker:
+      - Getting Started: notifications/ptbot/getting-started.md
+      - Features: notifications/ptbot/features.md
 
 - FAQ:
   - FAQ: faq.md