Skip to content

Commit b68d766

Browse files
committed
chore(docs): add provider schema
1 parent cd1599f commit b68d766

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/index.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,19 @@
33
page_title: "envbuilder Provider"
44
subcategory: ""
55
description: |-
6-
6+
Envbuilder Provider
7+
The Envbuilder provider can be used to check for the presence of a Docker image previously built by Envbuilder https://github.com/coder/envbuilder.
8+
This allows re-using a previously built image pushed to a Docker registry without having to rebuild it.
9+
An image built by Envbuilder also embeds the Envbuilder binary inside the image, allowing for the image to be used to build other images.
710
---
811

912
# envbuilder Provider
1013

14+
# Envbuilder Provider
1115

16+
The Envbuilder provider can be used to check for the presence of a Docker image previously built by [Envbuilder](https://github.com/coder/envbuilder).
17+
This allows re-using a previously built image pushed to a Docker registry without having to rebuild it.
18+
An image built by Envbuilder also embeds the Envbuilder binary inside the image, allowing for the image to be used to build other images.
1219

1320
## Example Usage
1421

internal/provider/provider.go

+6
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ func (p *EnvbuilderProvider) Metadata(ctx context.Context, req provider.Metadata
3636
func (p *EnvbuilderProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
3737
resp.Schema = schema.Schema{
3838
Attributes: map[string]schema.Attribute{},
39+
MarkdownDescription: `# Envbuilder Provider
40+
41+
The Envbuilder provider can be used to check for the presence of a Docker image previously built by [Envbuilder](https://github.com/coder/envbuilder).
42+
This allows re-using a previously built image pushed to a Docker registry without having to rebuild it.
43+
An image built by Envbuilder also embeds the Envbuilder binary inside the image, allowing for the image to be used to build other images.
44+
`,
3945
}
4046
}
4147

0 commit comments

Comments
 (0)