generated from pulumi/pulumi-tf-provider-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docs): update readme and docs for registry (#41)
- Loading branch information
Showing
18 changed files
with
159 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
title: Vercel | ||
meta_desc: Provides an overview of the Vercel Provider for Pulumi. | ||
layout: package | ||
--- | ||
|
||
The `Vercel` provider for Pulumi can be used to provision any of the resources available with `Vercel`. | ||
|
||
## Example | ||
|
||
{{< chooser language "javascript,typescript,python" >}} | ||
|
||
{{% choosable language javascript %}} | ||
|
||
```javascript | ||
"use strict"; | ||
const vercel = require("@pulumiverse/vercel"); | ||
|
||
const project = new vercel.Project("pulumi-vercel", { | ||
name: "pulumi-vercel", | ||
rootDirectory: "src", | ||
}); | ||
|
||
const deployment = new vercel.Deployment("deployment", { | ||
projectId: project.id, | ||
production: true, | ||
files: vercel.getProjectDirectoryOutput({ path: "./src" }).files, | ||
}); | ||
``` | ||
|
||
{{% /choosable %}} | ||
|
||
{{% choosable language typescript %}} | ||
|
||
```typescript | ||
import * as vercel from "@pulumiverse/vercel"; | ||
|
||
const project = new vercel.Project("pulumi-vercel", { | ||
name: "pulumi-vercel", | ||
rootDirectory: "src", | ||
}); | ||
|
||
const deployment = new vercel.Deployment("deployment", { | ||
projectId: project.id, | ||
production: true, | ||
files: vercel.getProjectDirectoryOutput({ path: "./src" }).files, | ||
}); | ||
``` | ||
|
||
{{% /choosable %}} | ||
{{% choosable language python %}} | ||
|
||
```python | ||
import pulumiverse_vercel as vercel | ||
import pulumi | ||
|
||
project = vercel.Project("pulumi-vercel", | ||
name="pulumi-vercel", | ||
rootDirectory="src") | ||
|
||
deployment = vercel.Deployment("deployment", | ||
name="pulumi-vercel", | ||
project_id=project.id, | ||
production="true") | ||
``` | ||
|
||
{{% /choosable %}} | ||
|
||
{{< /chooser >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: Vercel Installation & Configuration | ||
meta_desc: Information on how to install the Vercel provider. | ||
layout: package | ||
--- | ||
|
||
## Installation | ||
|
||
The Pulumi `Vercel` provider is available as a package in all Pulumi languages: | ||
|
||
- JavaScript/TypeScript: [`@pulumiverse/vercel`](https://www.npmjs.com/package/@pulumiverse/vercel) | ||
- Python: [`pulumiverse-vercel`](https://pypi.org/project/pulumiverse-vercel/) | ||
- Go: [`github.com/pulumiverse/pulumi-vercel/sdk/v3`](https://pkg.go.dev/github.com/pulumiverse/pulumi-vercel/sdk/v3) | ||
- .NET: [`Pulumiverse.vercel`](https://www.nuget.org/packages/Pulumiverse.vercel) | ||
|
||
## Installing | ||
|
||
This package is available for several languages/platforms: | ||
|
||
### Node.js (JavaScript/TypeScript) | ||
|
||
To use from JavaScript or TypeScript in Node.js, install using either `npm`: | ||
|
||
```bash | ||
npm install @pulumiverse/vercel | ||
``` | ||
|
||
or `yarn`: | ||
|
||
```bash | ||
yarn add @pulumiverse/vercel | ||
``` | ||
|
||
### Python | ||
|
||
To use from Python, install using `pip`: | ||
|
||
```bash | ||
pip install pulumiverse-vercel | ||
``` | ||
|
||
### Go | ||
|
||
To use from Go, use `go get` to grab the latest version of the library: | ||
|
||
```bash | ||
go get github.com/pulumiverse/pulumi-vercel/sdk/go/... | ||
``` | ||
|
||
### .NET | ||
|
||
To use from .NET, install using `dotnet add package`: | ||
|
||
```bash | ||
dotnet add package Pulumiverse.vercel | ||
``` | ||
|
||
## Configuration | ||
|
||
The following configuration points are available for the `vercel` provider: | ||
|
||
- `vercel:apiKey` (environment: `VERCEL_API_KEY`) - the API key for `vercel` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
name: vercel-ts | ||
runtime: nodejs | ||
description: A minimal TypeScript Pulumi program for Vercel |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters