Skip to content

Remove subcategory field from frontmatter in default provider template. #446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 16, 2025
Merged

Remove subcategory field from frontmatter in default provider template. #446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52bedad
Remove subcategory field from frontmatter in default provider template.
jedesroches Feb 6, 2025
ea77d82
Merge branch 'main' into main
jedesroches May 16, 2025
b456bad
Fix failing tests
SBGoods Jun 13, 2025
7e3cd9a
Add changelog entry
SBGoods Jun 13, 2025
4a09983
Merge branch 'main' into main
SBGoods Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changes/unreleased/BUG FIXES-20250613-152846.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: BUG FIXES
body: 'generate: Remove `subcategory` field from default provider templates'
time: 2025-06-13T15:28:46.039473-04:00
custom:
Issue: "446"
1 change: 0 additions & 1 deletion ...cs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ data "scaffolding_example" "example" {
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
subcategory: ""
description: |-
Example provider
---
Expand Down
1 change: 0 additions & 1 deletion ...estdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ rendering "resources/example.md.tmpl"
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
subcategory: ""
description: |-
Example provider
---
Expand Down
1 change: 0 additions & 1 deletion ...ndocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ example(input string, variadicInput string...) string
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
subcategory: ""
description: |-
Example provider
---
Expand Down
1 change: 0 additions & 1 deletion cmd/tfplugindocs/testdata/scripts/schema-json/generate/nested_id_attribute.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ rendering "resources/example.md.tmpl"
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
subcategory: ""
description: |-
Example provider
---
Expand Down
1 change: 0 additions & 1 deletion internal/provider/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,6 @@ description: |-
const defaultProviderTemplate providerTemplate = `---
` + frontmatterComment + `
page_title: "{{.ProviderShortName}} Provider"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---
Expand Down