Merge pull request #445 from rollbar/pawel/update_docs

updating docs

Author: pawelsz-rb

docs/resources/integration.md

@@ -13,22 +13,14 @@ This resource can manage configuration for the Slack, Webhook, Email and PagerDu
 Example Usage
 -------------
 
-```hcl
-# Set the rollbar provider to manage a project
-#
-# NOTE: the account access token `api_key` is not required
-# for managing project however it should be set if you want
-# to use the provider for managing account-level resources
-# in addition to project-level resources
+**Option 1: Using a project access token**
 
+```hcl
 provider "rollbar" {
     api_key         = "my-account-access-token"  # optional for this resource
     project_api_key = "my-project-access-token"
 }
 
-# Configure the Slack integration for the project
-#
-
 resource "rollbar_integration" "slack_integration" {
   slack {
     enabled = false
@@ -38,29 +30,20 @@ resource "rollbar_integration" "slack_integration" {
   }
 }
 
-# Configure the Webhook integration for the project
-#
-
 resource "rollbar_integration" "webhook_integration" {
   webhook {
     enabled = true
     url = "https://www.example.com"
   }
 }
 
-# Configure the Email integration for the project
-#
-
 resource "rollbar_integration" "email_integration" {
   email {
     enabled = true
     scrub_params = true
   }
 }
 
-# Configure the PagerDuty integration for the project
-#
-
 resource "rollbar_integration" "pagerduty_integration" {
   pagerduty {
     enabled = false
@@ -69,11 +52,33 @@ resource "rollbar_integration" "pagerduty_integration" {
 }
 ```
 
+**Option 2: Using an account access token with `project_id`**
+
+If you prefer not to configure a separate project access token, you can use the account access token and specify `project_id` on each resource:
+
+```hcl
+provider "rollbar" {
+    api_key = "my-account-access-token"
+}
+
+resource "rollbar_integration" "slack_integration" {
+  project_id = 123456
+  slack {
+    enabled = false
+    channel =  "#demo"
+    service_account_id = "1234r45"
+    show_message_buttons = true
+  }
+}
+```
+
 Argument Reference
 ------------------
 
 The following arguments are supported:
 
+* `project_id` - (Optional) The Rollbar project ID. When set, the account access token (`api_key`) is used with this project ID instead of requiring a separate project access token (`project_api_key`).
+
 Slack:
 
 * `enabled` - (Required) Boolean that enables the Slack notifications globally

docs/resources/notification.md

@@ -14,21 +14,14 @@ This resource can manage notification rules for different integration channels.
 Example Usage
 -------------
 
-```hcl
-# Set the rollbar provider to manage a project
-#
-# NOTE: the account access token `api_key` is not required
-# for managing project however it should be set if you want
-# to use the provider for managing account-level resources
-# in addition to project-level resources
+**Option 1: Using a project access token**
 
+```hcl
 provider "rollbar" {
     api_key         = "my-account-access-token"  # optional for this resource
     project_api_key = "my-project-access-token"
 }
 
-# Create an email notification for the project
-#
 resource "rollbar_notification" "email" {
   channel = "email"
   rule {
@@ -41,7 +34,35 @@ resource "rollbar_notification" "email" {
     }
   }
   config {
-    users = ["travis.mattera@rollbar.com"]
+    users = ["user@rollbar.com"]
+    teams = ["test-team-example"]
+  }
+}
+```
+
+**Option 2: Using an account access token with `project_id`**
+
+If you prefer not to configure a separate project access token, you can use the account access token and specify `project_id` on each resource:
+
+```hcl
+provider "rollbar" {
+    api_key = "my-account-access-token"
+}
+
+resource "rollbar_notification" "email" {
+  project_id = 123456
+  channel    = "email"
+  rule {
+    enabled = true
+    trigger = "occurrence_rate"
+    filters {
+      type   = "rate"
+      period = 300
+      count  = 10
+    }
+  }
+  config {
+    users = ["user@rollbar.com"]
     teams = ["test-team-example"]
   }
 }
@@ -52,6 +73,7 @@ Argument Reference
 
 The following arguments are supported:
 
+* `project_id` - (Optional) The Rollbar project ID. When set, the account access token (`api_key`) is used with this project ID instead of requiring a separate project access token (`project_api_key`).
 * `channel` - (Required) The notification channel (eg. `slack`, `pagerduty`, `email`, `webhook`) to configure a notification rule(s) for
 * `rule` - (Required) An array of expression configurations for notification rules.  Structure is [documented below](#nested_rule)
 * `config` - (Required) An array of configurations for notification rules.  Structure is [documented below](#nested_config)

docs/resources/service_links.md

@@ -10,33 +10,42 @@ This resource can manage service links.  See the following api documentation for
 Example Usage
 -------------
 
-```hcl
-# Set the rollbar provider to manage a project
-#
-# NOTE: the account access token `api_key` is not required
-# for managing project however it should be set if you want
-# to use the provider for managing account-level resources
-# in addition to project-level resources
+**Option 1: Using a project access token**
 
+```hcl
 provider "rollbar" {
     api_key         = "my-account-access-token"  # optional for this resource
     project_api_key = "my-project-access-token"
 }
 
-# Create a service links for a project
-#
-
 resource "rollbar_service_link" "service_link" {
   name = "service_link_name"
   template = "https://some-service.xyz/commit/{{code_version}}"
 }
 ```
 
+**Option 2: Using an account access token with `project_id`**
+
+If you prefer not to configure a separate project access token, you can use the account access token and specify `project_id` on each resource:
+
+```hcl
+provider "rollbar" {
+    api_key = "my-account-access-token"
+}
+
+resource "rollbar_service_link" "service_link" {
+  project_id = 123456
+  name       = "service_link_name"
+  template   = "https://some-service.xyz/commit/{{code_version}}"
+}
+```
+
 Argument Reference
 ------------------
 
 The following arguments are supported:
 
+* `project_id` - (Optional) The Rollbar project ID. When set, the account access token (`api_key`) is used with this project ID instead of requiring a separate project access token (`project_api_key`).
 * `name` - (Required) The name of the service link
 * `template` - (Required) The url that contains templated variables referencing an occurrences data. [Examples](https://docs.rollbar.com/docs/service-links)