Skip to content

Conversation

tobio
Copy link
Member

@tobio tobio commented Sep 17, 2025

Currently we require each resource/data source to define essentially a duplicate docs template just to set the subcategory frontmatter entry.

This PR:

  • Adds a generic template for data sources and template which extracts the subcategory from the resource name.
  • Overrides the default subcategory from some specific resources which don't fit the same naming pattern
  • Removes the duplicate resource/data source templates
  • Pulls out complex descriptions into an external markdown file to simply editing. These files are then directly embedded into the resource binary through Golang embed.
  • Reformats links in the docs to present more natural language to consumers.

@tobio tobio self-assigned this Sep 17, 2025
@tobio tobio merged commit 5b31272 into main Sep 17, 2025
50 checks passed
@tobio tobio deleted the better-default-docs branch September 17, 2025 05:42
tobio added a commit that referenced this pull request Sep 17, 2025
* origin/main:
  Improve docs generation (#1313)
  Add optional preventInitialBackfill for SLO API (#1071)
tobio added a commit that referenced this pull request Sep 23, 2025
* origin/main:
  fix: nil reference in api.kibana_synthetics.go:418 in case of unmarshable arrays (#1320)
  Bump github.com/hashicorp/terraform-plugin-framework (#1326)
  Bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.37.0 to 2.38.0 (#1325)
  chore(deps): update golang:1.25.1 docker digest to 8305f5f (#1322)
  Clarify how acceptance tests should be run (#1324)
  Move diag utilities from utils to dedicated diagutil package (#1317)
  Add support for Kafka Fleet output types. (#1302)
  Allow a default for `allow_restricted_indices` within an API Key role descriptor (#1315)
  Improve docs generation (#1313)
  Add optional preventInitialBackfill for SLO API (#1071)
  Add support for dataViewId (#1305)
  [Feature] Add unenrollment_timeout parameter to Fleet Agent Policy resource (#1306)
  chore(deps): update actions/setup-go action to v6 (#1301)
  chore(deps): update golang docker tag to v1.25.1 (#1300)
  Update generated SLO client.  (#1303)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants