Skip to content

Commit 477d1db

Browse files
committed
docs: per-resource examples, service subcategories, and auth/migration guides
- examples/: a self-contained, terraform-fmt-clean Terraform example for every resource (25) and data source (19), plus import.sh for importable resources. tfplugindocs renders these as the "Example Usage" and "Import" sections. - templates/resources.md.tmpl + data-sources.md.tmpl: derive a per-service "subcategory" from the type name so the registry groups pages by Identity, Images, Networking, Compute, and Block Storage. - templates/guides/: an Authentication guide (password/token/app-cred, clouds.yaml, TLS, endpoint overrides, precedence) and a Migrating-from-terraform-provider- openstack guide (name mapping, behavioral notes, import workflow). - gitignore docs/guides/ (rendered like the rest of docs/, produced by make generate). Verified: terraform fmt -check on ./examples passes, make generate renders all pages with Example Usage/Import + guides, build/gofmt clean.
1 parent fc33893 commit 477d1db

75 files changed

Lines changed: 793 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ PCD-CE-Deployment-Handoff.md
3333

3434
# Generated registry docs — produced by `make generate` (tfplugindocs) on demand and
3535
# at release time; not committed. (docs/compatibility/ is hand-written and kept.)
36+
# Guides are authored in templates/guides/ and rendered into docs/guides/.
3637
/docs/index.md
3738
/docs/resources/
3839
/docs/data-sources/
40+
/docs/guides/
3941

4042
# Editors / OS
4143
.idea/

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_blockstorage_snapshot" "example" {
2+
name = "tf-example-snapshot"
3+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_blockstorage_volume" "example" {
2+
name = "tf-example-volume"
3+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_compute_availability_zones" "example" {
2+
state = "available"
3+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_compute_flavor" "example" {
2+
name = "m1.large"
3+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_compute_keypair" "example" {
2+
name = "tf-example-keypair"
3+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
data "pcd_identity_auth_scope" "example" {
2+
name = "tf-example-scope"
3+
region = "RegionOne"
4+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_identity_project" "example" {
2+
name = "tf-example-project"
3+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data "pcd_identity_role" "example" {
2+
name = "member"
3+
}

0 commit comments

Comments
 (0)