Start creating docs for integrations

jimmyjayp · jimmyjayp · commit be552e257f89 · 2021-11-21T01:24:28.000-05:00
diff --git a/api_server/docs/integrations/README.md b/api_server/docs/integrations/README.md
@@ -1,7 +1,17 @@
 # Integrations
 
 ## 3rd Party Services
+- [Asana](asana.md)
+- [Azure DevOps](azure-devops.md)
+- [Bitbucket](bitbucket.md)
+- [Github](github.md)
+- [Gitlab](gitlab.md)
+- [jira](jira.md)
+- [linear](linear.md)
+- [msteams](msteams.md)
+- [newrelic](newrelic.md)
 - [Slack](slack.md)
+- [Trello](trello.md)
 
 ## OAuth & SSO Handshake
 
diff --git a/api_server/docs/integrations/asana.md b/api_server/docs/integrations/asana.md
diff --git a/api_server/docs/integrations/azure-devops.md b/api_server/docs/integrations/azure-devops.md
diff --git a/api_server/docs/integrations/bitbucket.md b/api_server/docs/integrations/bitbucket.md
diff --git a/api_server/docs/integrations/github.md b/api_server/docs/integrations/github.md
@@ -0,0 +1,33 @@
+# Integration with Github
+
+## Github Cloud (github.com)
+
+### SSO / OAuth
+
+Github.com SSO support for CodeStream implements the standard OAuth procedure
+which requires a dedicated OAuth application on Github.com with the appropriate
+settings.
+
+1. Login to Github.com
+
+1. `Settings > Developer Settings > OAuth Apps > Create New App`
+    1. Set the **Authorization Callback URL** to for your API's URL (similar to
+       `https://api.codestream.us/no-auth/provider-token/github`)
+    1. Generate a client secret and add both the Client ID and secret to the
+       secrets database.
+
+1. Add the credentials to the CodeStream server's config file in the
+   `intergrations` section.
+    ```
+    {
+        "integrations": {
+            "github": {
+                "cloud": {
+                    "appClientId": "***************************",
+                    "appClientSecret": "*************************",
+                    "disabled": false
+                }
+            }
+        }
+    }
+    ```
diff --git a/api_server/docs/integrations/gitlab.md b/api_server/docs/integrations/gitlab.md
@@ -0,0 +1 @@
+# Gitlab Integration
diff --git a/api_server/docs/integrations/jira.md b/api_server/docs/integrations/jira.md
@@ -0,0 +1 @@
+# Jira (Atlassian Cloud)
diff --git a/api_server/docs/integrations/linear.md b/api_server/docs/integrations/linear.md
@@ -0,0 +1 @@
+# Linear Integration
diff --git a/api_server/docs/integrations/msteams.md b/api_server/docs/integrations/msteams.md
@@ -0,0 +1 @@
+# MS Teams Integrations
diff --git a/api_server/docs/integrations/newrelic.md b/api_server/docs/integrations/newrelic.md
@@ -0,0 +1 @@
+# New Relic Integration
diff --git a/api_server/docs/integrations/slack.md b/api_server/docs/integrations/slack.md
@@ -65,3 +65,8 @@ them to the CodeStream configuration file.
 - Client ID
 - Client Secret
 - Signing Secret
+
+
+## Permalink to Code Requesting Auth
+
+This is the _source of truth_ where slack access is concerned.
diff --git a/api_server/docs/integrations/trello.md b/api_server/docs/integrations/trello.md
@@ -0,0 +1,27 @@
+# Integration with Trello
+
+The API requires a developer key from Trello which is matched to the redirect
+URL's used in the OAuth process. It is not used for the CodeStream extension's
+issues features.
+
+The Trello developer key is associated with a trello account. First, login to
+Trello and then go to https://trello.com/app-key/. Here you can see the key and
+the few properties associated with it.
+
+1. Add the key to the CodeStream configuration file in the `integrations`
+   section.
+    ```
+    {
+        "integrations": {
+            "trello": {
+                "cloud": {
+                    "apiKey": "***************************",
+                    "disabled": false
+                }
+            }
+        }
+    }
+    ```
+
+1. Make sure your API server's URL is added to the **Allowed Origins** section.
+   For example, `https://api.codestream.com/`.
