Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation #127

Merged
merged 2 commits into from
Jul 11, 2024
Merged

Update documentation #127

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d21142
Update documentation
terryyanko Jul 11, 2024
e8a9052
Fix nits
mjeffryes Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Ensure the following tools are installed and present in your `$PATH`:

- [`pulumictl`](https://github.com/pulumi/pulumictl#installation)
- [Go 1.17](https://golang.org/dl/) or 1.latest
- [NodeJS](https://nodejs.org/en/) 14.x. We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage NodeJS installations.
- [NodeJS](https://nodejs.org/en/) 14.x or greater. We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage NodeJS installations.
mjeffryes marked this conversation as resolved.
Show resolved Hide resolved
- [Yarn](https://yarnpkg.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Python](https://www.python.org/downloads/) (called as `python3`). For recent versions of MacOS, the system-installed version is fine.
Expand Down Expand Up @@ -116,6 +116,9 @@ Pulumi provider repositories have the following general structure:

## Adding Mappings, Building the Provider and SDKs

> [!NOTE]
> Recent versions of this repository leverage [automatic token mapping](https://github.com/pulumi/pulumi-terraform-bridge/blob/master/docs/automatic-token-mapping.md) as an alternative to mapping resources manually. Unless you have a specific use case that requires manual mapping, you may skip this section.
mjeffryes marked this conversation as resolved.
Show resolved Hide resolved

In this section we will add the mappings that allow the interoperation between the Pulumi provider and the Terraform provider. Terraform resources map to an identically named concept in Pulumi. Terraform data sources map to plain old functions in your supported programming language of choice. Pulumi also allows provider functions and resources to be grouped into _namespaces_ to improve the cohesion of a provider's code, thereby making it easier for developers to use. If your provider has a large number of resources, consider using namespaces to improve usability.

The following instructions all pertain to `provider/resources.go`, in the section of the code where we construct a `tfbridge.ProviderInfo` object:
Expand Down