Add installation docs and automation (#580)

Part of pulumi/home#3598

Generates a single index.md file with relevant content and adds
automation.

.ci-mgmt.yaml

@@ -10,3 +10,4 @@ plugins:
     version: "4.10.0"
 team: ecosystem
 pulumiConvert: 1
+registryDocs: true

Makefile

@@ -29,7 +29,7 @@ development: install_plugins provider build_sdks install_sdks
 
 build: install_plugins provider build_sdks install_sdks
 
-build_sdks: build_nodejs build_python build_dotnet build_go build_java 
+build_sdks: build_nodejs build_python build_dotnet build_go build_java build_registry_docs
 
 install_go_sdk:
 
@@ -96,6 +96,10 @@ build_python: upstream
 		cd ./bin && \
 		../venv/bin/python -m build .
 
+# Run the bridge's registry-docs command to generated the content of the installation docs/ folder at provider repo root
+build_registry_docs:
+	$(WORKING_DIR)/bin/$(TFGEN) registry-docs --out $(WORKING_DIR)/docs
+
 clean:
 	rm -rf sdk/{dotnet,nodejs,go,python}
 

docs/_index.md

@@ -0,0 +1,215 @@
+---
+title: Signalfx Provider
+meta_desc: Provides an overview on how to configure the Pulumi Signalfx provider.
+layout: package
+---
+## Installation
+
+The signalfx provider is available as a package in all Pulumi languages:
+
+* JavaScript/TypeScript: [`@pulumi/signalfx`](https://www.npmjs.com/package/@pulumi/signalfx)
+* Python: [`pulumi-signalfx`](https://pypi.org/project/pulumi-signalfx/)
+* Go: [`github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx`](https://github.com/pulumi/pulumi-signalfx)
+* .NET: [`Pulumi.Signalfx`](https://www.nuget.org/packages/Pulumi.Signalfx)
+* Java: [`com.pulumi/signalfx`](https://central.sonatype.com/artifact/com.pulumi/signalfx)
+## Overview
+
+The [Splunk Observability Cloud](https://www.splunk.com/en_us/products/observability.html) provider, formerly known as SignalFx Pulumi provider, lets you interact with the resources supported by Splunk Observability Cloud. You must configure the provider with credentials before using it.
+
+Use the navigation to learn more about the available resources.
+# Learn about Splunk Observability Cloud
+
+To learn more about Splunk Observability Cloud and its features, see [the official documentation](https://docs.splunk.com/observability/en/).
+
+You can use the SignalFlow programming language to create charts and detectors using `programText`. For more information about SignalFlow, see the [Splunk developer documentation](https://dev.splunk.com/observability/docs/signalflow/).
+# Authentication
+
+When authenticating to the Splunk Observability Cloud API you can use either an Org token or a
+Session token. See [Authenticate API Requests](https://dev.splunk.com/observability/docs/apibasics/authentication_basics/) in the Splunk developer documentation.
+
+Session tokens are short-lived and provide administrative permissions to edit integrations. They expire relatively quickly, but let you manipulate some sensitive resources. Resources that require session tokens are flagged in their documentation.
+
+> **NOTE** Separate the less sensitive resources, such as dashboards, from the
+more sensitive ones, such as integrations, to avoid having to change tokens.
+## Example
+
+The following example shows how to configure the Splunk Observability Cloud provider for Pulumi:
+
+{{< chooser language "typescript,python,go,csharp,java,yaml" >}}
+{{% choosable language typescript %}}
+```yaml
+# Pulumi.yaml provider configuration file
+name: configuration-example
+runtime: nodejs
+config:
+    signalfx:authToken:
+        value: 'TODO: "${var.signalfx_auth_token}"'
+
+```
+```typescript
+import * as pulumi from "@pulumi/pulumi";
+import * as signalfx from "@pulumi/signalfx";
+
+// Create a new detector
+const _default = new signalfx.Detector("default", {});
+// Create a new dashboard
+const defaultDashboard = new signalfx.Dashboard("default", {});
+```
+{{% /choosable %}}
+{{% choosable language python %}}
+```yaml
+# Pulumi.yaml provider configuration file
+name: configuration-example
+runtime: python
+config:
+    signalfx:authToken:
+        value: 'TODO: "${var.signalfx_auth_token}"'
+
+```
+```python
+import pulumi
+import pulumi_signalfx as signalfx
+
+# Create a new detector
+default = signalfx.Detector("default")
+# Create a new dashboard
+default_dashboard = signalfx.Dashboard("default")
+```
+{{% /choosable %}}
+{{% choosable language csharp %}}
+```yaml
+# Pulumi.yaml provider configuration file
+name: configuration-example
+runtime: dotnet
+config:
+    signalfx:authToken:
+        value: 'TODO: "${var.signalfx_auth_token}"'
+
+```
+```csharp
+using System.Collections.Generic;
+using System.Linq;
+using Pulumi;
+using SignalFx = Pulumi.SignalFx;
+
+return await Deployment.RunAsync(() =>
+{
+    // Create a new detector
+    var @default = new SignalFx.Detector("default");
+
+    // Create a new dashboard
+    var defaultDashboard = new SignalFx.Dashboard("default");
+
+});
+
+```
+{{% /choosable %}}
+{{% choosable language go %}}
+```yaml
+# Pulumi.yaml provider configuration file
+name: configuration-example
+runtime: go
+config:
+    signalfx:authToken:
+        value: 'TODO: "${var.signalfx_auth_token}"'
+
+```
+```go
+package main
+
+import (
+	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
+	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
+)
+
+func main() {
+	pulumi.Run(func(ctx *pulumi.Context) error {
+		// Create a new detector
+		_, err := signalfx.NewDetector(ctx, "default", nil)
+		if err != nil {
+			return err
+		}
+		// Create a new dashboard
+		_, err = signalfx.NewDashboard(ctx, "default", nil)
+		if err != nil {
+			return err
+		}
+		return nil
+	})
+}
+```
+{{% /choosable %}}
+{{% choosable language yaml %}}
+```yaml
+# Pulumi.yaml provider configuration file
+name: configuration-example
+runtime: yaml
+config:
+    signalfx:authToken:
+        value: 'TODO: "${var.signalfx_auth_token}"'
+
+```
+```yaml
+resources:
+  # Create a new detector
+  default:
+    type: signalfx:Detector
+  # Create a new dashboard
+  defaultDashboard:
+    type: signalfx:Dashboard
+    name: default
+```
+{{% /choosable %}}
+{{% choosable language java %}}
+```yaml
+# Pulumi.yaml provider configuration file
+name: configuration-example
+runtime: java
+config:
+    signalfx:authToken:
+        value: 'TODO: "${var.signalfx_auth_token}"'
+
+```
+```java
+package generated_program;
+
+import com.pulumi.Context;
+import com.pulumi.Pulumi;
+import com.pulumi.core.Output;
+import com.pulumi.signalfx.Detector;
+import com.pulumi.signalfx.Dashboard;
+import java.util.List;
+import java.util.ArrayList;
+import java.util.Map;
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+public class App {
+    public static void main(String[] args) {
+        Pulumi.run(App::stack);
+    }
+
+    public static void stack(Context ctx) {
+        // Create a new detector
+        var default_ = new Detector("default");
+
+        // Create a new dashboard
+        var defaultDashboard = new Dashboard("defaultDashboard");
+
+    }
+}
+```
+{{% /choosable %}}
+{{< /chooser >}}
+## Configuration Reference
+
+The following configuration inputs are supported:
+
+* `authToken` - (Required) The auth token for [authentication](https://developers.signalfx.com/basics/authentication.html). You can also set it using the `SFX_AUTH_TOKEN` environment variable.
+* `apiUrl` - (Optional) The API URL to use for communicating with Splunk Observability Cloud. This is helpful for organizations that need to set their realm or use a proxy. You can also set it using the `SFX_API_URL` environment variable.
+* `customAppUrl` - (Optional) The application URL that users might use to interact with assets in the browser. Used by organizations on specific realms or with a custom [SSO domain](https://docs.splunk.com/observability/en/admin/authentication/SSO/sso-about.html). You can also set it using the `SFX_CUSTOM_APP_URL` environment variable.
+* `timeoutSeconds` - (Optional) The total timeout duration to wait when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `120`.
+* `retryMaxAttempts` - (Optional) The number of retry attempts when making HTTP API calls to Splunk Observability Cloud. Defaults to `4`.
+* `retryWaitMinSeconds` - (Optional) The minimum wait time between retry attempts when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `1`.
+* `retryWaitMaxSeconds` - (Optional) The maximum wait time between retry attempts when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `30`.