docs: improve explanation and compatibility of several resources

README.md

@@ -137,13 +137,13 @@ https://registry.terraform.io/providers/pactflow/pact/latest
 | [Pact](docs/index.md)                                       | Provider | Pact Broker + Pactflow | Configures a target Pact Broker (such as a pactflow.io account) |
 | [Pacticipant](docs/resources/pacticipant.md)                | Resource | Pact Broker + Pactflow | Create applications (known as Pacticipants)                     |
 | [Webhook](docs/resources/webhook.md)                        | Resource | Pact Broker + Pactflow | Configures a webhook to trigger on certain platform events      |
-| [Secret](docs/resources/secret.md)                          | Resource | Pactflow               | Create an encrypted secret for use in Webhooks                  |
+| [Secret](docs/resources/secret.md)                          | Resource | Pactflow              | Create an encrypted secret for use in Webhooks                  |
 | [API Token](docs/resources/token.md)                        | Resource | Pactflow               | Manage Pactflow API Tokens                                      |
-| [Users](docs/resources/user.md)                             | Resource | Pactflow               | Manage Pactflow Users                                           |
+| [Users](docs/resources/user.md)                             | Resource | Pactflow (cloud only)               | Manage Pactflow Users                                           |
 | [Roles](docs/resources/role.md)                             | Resource | Pactflow               | Manage Pactflow Roles                                           |
 | [Teams](docs/resources/team.md)                             | Resource | Pactflow               | Manage Pactflow Teams                                           |
 | [Environments](docs/resources/environment.md)               | Resource | Pact Broker + Pactflow | Manage Environments                                             |
-| [Authentication Settings](docs/resources/authentication.md) | Resource | Pactflow               | Manage Pactflow Authentication (Github, Google etc.)            |
+| [Authentication Settings](docs/resources/authentication.md) | Resource | Pactflow (cloud only)              | Manage Pactflow Authentication (Github, Google etc.)            |
 
 See our [Docs](./docs) folder for all plugins.
 

docs/resources/application.md

@@ -2,6 +2,10 @@
 
 This resource manages the lifecycle of a _Application_ (also known as a pacticipant). An Application may perform the role of a consumer or a provider in the Pact ecosystem.
 
+## Compatibility
+
+-> This feature is available to both Pactflow and OSS users
+
 ## Example Usage
 
 The following examples show the basic usage of the resource.

docs/resources/authentication.md

@@ -2,7 +2,7 @@
 
 This resource manages the authentication settings on a Pactflow account.
 
--> This is currently only supported for the Pactflow.io platform, and does not apply to the on-premise version
+-> This is currently only supported for the pactflow.io cloud platform, and does not apply to the on-premise version
 
 ## Example Usage
 The following examples show the basic usage of the resource.

docs/resources/environment.md

@@ -4,6 +4,10 @@ This resource allows you to create custom Environments for assigning to Users.
 
 See https://docs.pact.io/pact_broker/recording_deployments_and_releases#environments and https://docs.pactflow.io/docs/user-interface/settings/environments for further documentation on managing environments.
 
+## Compatibility
+
+-> This feature is available to both Pactflow and OSS users
+
 ## Example Usage
 
 The following example shows the basic usage of the resource. We are creating a custom environment that allows the user permissions to manage people and teams:

docs/resources/pacticipant.md

@@ -4,6 +4,10 @@ This resource manages the lifecycle of a _Pacticipant_. A Pacticipant is an appl
 
 !> This resource is deprecated in favour of the `pact_application` resource.
 
+## Compatibility
+
+-> This feature is available to both Pactflow and OSS users
+
 ## Example Usage
 The following examples show the basic usage of the resource.
 

docs/resources/role.md

@@ -4,6 +4,10 @@ This resource allows you to create custom Roles for assigning to Users.
 
 See https://docs.pactflow.io/docs/permissions/predefined-roles for documentation on managing users and roles within Pactflow.
 
+## Compatibility
+
+-> This feature is only available for the Pactflow platform.
+
 ## Example Usage
 
 The following example shows the basic usage of the resource. We are creating a custom role that allows the user permissions to manage people and teams:

docs/resources/role_v1.md

@@ -6,6 +6,10 @@ This resource manages assigns existing platform roles to a given User.
 
 See https://docs.pactflow.io/docs/user-interface/#settings---users for documentation on managing users and roles within Pactflow.
 
+## Compatibility
+
+-> This feature is only available for the Pactflow platform.
+
 ## Example Usage
 The following examples show the basic usage of the resource. Here, we first create a user "billy" and attach a role to them, referencing the unique id (`uuid`) of the user.
 
@@ -16,7 +20,7 @@ resource "pact_user" "billy" {
   active = false
 }
 
-# Assignt to the billy the user by referencing its uuid
+# Assign to the billy the user by referencing its uuid
 resource "pact_role_v1" "billy_admin" {
   role = "administrator"
   user = pact_user.billy.uuid

docs/resources/secret.md

@@ -2,7 +2,9 @@
 
 This resource manages the lifecycle of a _Secret_. A Secret is an application that may perform the role of a consumer or a provider in the Pact ecosystem.
 
--> Thisis currently only supported for the Pactflow.io platform.
+## Compatibility
+
+-> This feature is only available for the Pactflow platform.
 
 ## Example Usage
 The following examples show the basic usage of the resource.

docs/resources/team.md

@@ -4,6 +4,10 @@ This resource allows you to create teams for grouping users and applications.
 
 https://docs.pactflow.io/docs/user-interface/settings/teams for documentation on managing teams.
 
+## Compatibility
+
+-> This feature is only available for the Pactflow platform.
+
 ## Example Usage
 
 The following examples show the basic usage of the resource. We are creating a custom role that allows the user permissions to manage people and teams:

docs/resources/token.md

@@ -1,10 +1,12 @@
 # Token Resource
 
-This resource manages the lifecycle of an _API Token_. A Token can be used to make API calls to the Pactflow platform.
+This resource manages the lifecycle of the _API Token_ of the current user. A Token can be used to make API calls to the Pactflow platform.
 
-!> **It is highly recommended that this resource only be used to import existing tokens, and not be used to update existing tokens - you are likely to end up locking yourself out this way**
+!> **It is highly recommended that this resource only be used to import existing tokens, and not be used to update existing tokens - you are likely to end up locking yourself out this way. This feature should not be used by most customers**
 
--> This is currently only supported for the Pactflow.io platform.
+## Compatibility
+
+-> This feature is only available for the Pactflow platform.
 
 ## Example Usage
 
@@ -21,7 +23,7 @@ resource "pact_token" "read_write_api_token" {
 }
 ```
 
-**NOTE**: There can be at most 1 of each type of token, as shown above. Our [roadamp](https://pactflow.io/pactflow-feature-roadmap/) includes expanded support for API tokens (multiple named tokens at the user and administration level).
+**NOTE**: There can be at most 1 of each type of token, as shown above. There is an open item on our [roadmap](https://github.com/pactflow/roadmap/issues/87) that includes expanded support for API tokens (multiple named tokens at the user and administration level).
 
 **NOTE**: If you change the `read-write` token, it will generate a new token and invalidate the existing token. You will need to use the new value returned to run Terraform again. For example, you may want to extract the `value` property using the Terraform [Output](https://www.terraform.io/docs/configuration/outputs.html) feature.
 

docs/resources/user.md

@@ -2,6 +2,8 @@
 
 This resource manages the lifecycle of a user.
 
+!> **This resource only works for Pactflow Cloud users, and is not compatible with the use of SSO providers (e.g. Google, SAML). That is, it will create users separate to any external Identity Provider you have configured**
+
 See https://docs.pactflow.io/docs/user-interface/#settings---users for documentation on managing users within Pactflow.
 
 ## Example Usage

docs/resources/webhook.md

@@ -8,6 +8,10 @@ Webhooks can be used in conjunction with the [can-i-deploy](https://github.com/p
 
 See [Webhooks](http://docs.pact.io/pact_broker/advanced_topics/webhooks/) for more information on configuring Webhooks.
 
+## Compatibility
+
+-> This feature is available to both Pactflow and OSS users
+
 ## Example Usage
 
 The following examples show the basic usage of the resource.