Skip to content

Commit 1fc310d

Browse files
committed
update readme in anticipation of going public
1 parent 74e695b commit 1fc310d

File tree

6 files changed

+91
-32
lines changed

6 files changed

+91
-32
lines changed

.github/assets/images/hero-image.png

144 KB
Loading

.github/assets/images/logo-black.png

2.09 KB
Loading

.github/assets/images/logo-white.png

2.09 KB
Loading

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://coder.com/docs/contributing/CODE_OF_CONDUCT

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Development
2+
3+
Currently, a branch of the coder terraform provider is required.
4+
5+
1. Git clone `[email protected]:coder/terraform-provider-coder.git`
6+
7+
- Checkout branch `stevenmasley/form_control`
8+
- Build the provider with `go build -o terraform-provider-coder`
9+
10+
1. Create a file named `.terraformrc` in your `$HOME` directory
11+
1. Add the following content:
12+
13+
```hcl
14+
provider_installation {
15+
# Override the coder/coder provider to use your local version
16+
dev_overrides {
17+
"coder/coder" = "/path/to/terraform-provider-coder"
18+
}
19+
20+
# For all other providers, install them directly from their origin provider
21+
# registries as normal. If you omit this, Terraform will _only_ use
22+
# the dev_overrides block, and so no other providers will be available.
23+
direct {}
24+
}
25+
```
26+
27+
Now you are using the right terraform provider.
28+
29+
To run preview:
30+
31+
1. `cd site`
32+
2. `pnpm install`
33+
3. `cd ..`
34+
4. `go run ./cmd/preview/main.go web --pnpm=site`

README.md

Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,56 @@
1-
# Development
2-
3-
Currently, a branch of the coder terraform provider is required.
4-
5-
6-
1. Git clone `[email protected]:coder/terraform-provider-coder.git`
7-
- Checkout branch `stevenmasley/form_control`
8-
- Build the provider with `go build -o terraform-provider-coder`
9-
1. Create a file named `.terraformrc` in your `$HOME` directory
10-
1. Add the following content:
11-
12-
```hcl
13-
provider_installation {
14-
# Override the coder/coder provider to use your local version
15-
dev_overrides {
16-
"coder/coder" = "/path/to/terraform-provider-coder"
17-
}
18-
19-
# For all other providers, install them directly from their origin provider
20-
# registries as normal. If you omit this, Terraform will _only_ use
21-
# the dev_overrides block, and so no other providers will be available.
22-
direct {}
23-
}
24-
```
25-
26-
Now you are using the right terraform provider.
27-
28-
To run preview:
29-
1. `cd site`
30-
2. `pnpm install`
31-
3. `cd ..`
32-
4. `go run ./cmd/preview/main.go web --pnpm=site`
1+
<!-- markdownlint-disable MD041 -->
2+
<div align="center">
3+
<a href="https://coder.com#gh-light-mode-only">
4+
<img src="./.github/assets/images/logo-black.png" alt="Coder Logo Light" style="width: 128px">
5+
</a>
6+
<a href="https://coder.com#gh-dark-mode-only">
7+
<img src="./.github/assets/images/logo-white.png" alt="Coder Logo Dark" style="width: 128px">
8+
</a>
9+
10+
<h1>
11+
Workspace Parameters sourced from Terraform
12+
</h1>
13+
14+
<br>
15+
<br>
16+
17+
[Quickstart](#quickstart) | [Docs](https://coder.com/docs) |
18+
[Why Coder](https://coder.com/why) |
19+
[Premium](https://coder.com/pricing#compare-plans)
20+
21+
[![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder)
22+
[![release](https://img.shields.io/github/v/release/coder/preview)](https://github.com/coder/preview/releases/latest)
23+
[![godoc](https://pkg.go.dev/badge/github.com/coder/preview.svg)](https://pkg.go.dev/github.com/coder/preview)
24+
[![Go Report Card](https://goreportcard.com/badge/github.com/coder/preview)](https://goreportcard.com/report/github.com/coder/preview)
25+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9511/badge)](https://www.bestpractices.dev/projects/9511)
26+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/coder/preview/badge)](https://scorecard.dev/viewer/?uri=github.com%2Fcoder%2Fcoder)
27+
[![license](https://img.shields.io/github/license/coder/preview)](./LICENSE)
28+
29+
</div>
30+
31+
This repository contains a component of Coder that handles workspace parameter
32+
management via Terraform. It's responsible for extracting and managing
33+
[workspace parameters](https://coder.com/docs/admin/templates/extending-templates/parameters)
34+
from Terraform configurations, supporting [Coder's](https://coder.com) core
35+
functionality of creating cloud development environments (like EC2 VMs,
36+
Kubernetes Pods, and Docker containers).
37+
38+
The primary repository for Coder is [here](https://github.com/coder/coder).
39+
40+
<!--Should update this with the new cool form options -->
41+
<p align="center">
42+
<img src="./.github/assets/images/hero-image.png" alt="Coder Hero Image">
43+
</p>
44+
45+
<!-- TODO: Add a usage section that links to coder/coder doc for how to use the `preview` command in coder cli -->
46+
47+
## Support
48+
49+
Do you have a workspace template that has incorrect parameters? Please open
50+
[workspace template behavior issue](https://github.com/coder/preview/issues/new?template=workspace-template-bug-report.md).
51+
52+
For other bugs, feature requests, etc, feel free to
53+
[open an issue](https://github.com/coder/preview/issues/new).
54+
55+
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress
56+
features and chat with the community using Coder!

0 commit comments

Comments
 (0)