From d6192fcd1153cacf39ba26c9a72cab1ea1fd6f27 Mon Sep 17 00:00:00 2001
From: Cian Johnston <cian@coder.com>
Date: Wed, 21 Aug 2024 10:10:58 +0100
Subject: [PATCH] chore(docs): add provider schema (#39)
---
docs/index.md | 6 ++++--
internal/provider/provider.go | 3 +++
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 8148773..8bedaaa 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,12 +3,14 @@
page_title: "envbuilder Provider"
subcategory: ""
description: |-
-
+ The Envbuilder provider can be used to check for the presence of a container image previously built by Envbuilder https://github.com/coder/envbuilder.
+ This allows re-using a previously built image pushed to a container registry without having to rebuild it.
---
# envbuilder Provider
-
+The Envbuilder provider can be used to check for the presence of a container image previously built by [Envbuilder](https://github.com/coder/envbuilder).
+This allows re-using a previously built image pushed to a container registry without having to rebuild it.
## Example Usage
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
index d444c23..cfc0c61 100644
--- a/internal/provider/provider.go
+++ b/internal/provider/provider.go
@@ -36,6 +36,9 @@ func (p *EnvbuilderProvider) Metadata(ctx context.Context, req provider.Metadata
func (p *EnvbuilderProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
resp.Schema = schema.Schema{
Attributes: map[string]schema.Attribute{},
+ MarkdownDescription: `
+The Envbuilder provider can be used to check for the presence of a container image previously built by [Envbuilder](https://github.com/coder/envbuilder).
+This allows re-using a previously built image pushed to a container registry without having to rebuild it.`,
}
}