docs: add introduction for the registry

Vitesco-Technologies · Dec 20, 2023 · 01e2a46 · 01e2a46
1 parent f92e876
commit 01e2a46
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 6 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,16 +1,25 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "qip Provider"
-subcategory: ""
+page_title: "Provider: QIP"
 description: |-
-  
+  Resource and data provider for Nokia QIP.
 ---
 
-# qip Provider
+# Nokia QIP Provider
 
+The provider for Nokia QIP will allow you to retrieve metadata from QIP or manage IPv4 addresses including their DNS names.
 
+Features:
 
-## Example Usage
+- Data sources for `qip_v4address` and `qip_v4subnet`
+- Manage addresses with `qip_v4address`
+
+<!-- TODO: when published
+Also see the Terraform module [qip-address](https://github.com/Vitesco-Technologies/terraform-module-qip-address).
+-->
+
+Build based on the Swagger API documentation that should be available with your QIP instance: `https://qip.example.com.com/rest-api/`
+
+## Example
 
 ```terraform
 provider "qip" {

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -0,0 +1,26 @@
+---
+page_title: "Provider: QIP"
+description: |-
+  Resource and data provider for Nokia QIP.
+---
+
+# Nokia QIP Provider
+
+The provider for Nokia QIP will allow you to retrieve metadata from QIP or manage IPv4 addresses including their DNS names.
+
+Features:
+
+- Data sources for `qip_v4address` and `qip_v4subnet`
+- Manage addresses with `qip_v4address`
+
+<!-- TODO: when published
+Also see the Terraform module [qip-address](https://github.com/Vitesco-Technologies/terraform-module-qip-address).
+-->
+
+Build based on the Swagger API documentation that should be available with your QIP instance: `https://qip.example.com.com/rest-api/`
+
+## Example
+
+{{ tffile "examples/provider/provider.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}