docs: render provider name as "PCD" in generated doc titles - #41
Merged
Conversation
The overview heading rendered as "pcd Provider" and each resource/data-source page title as "... - pcd", using the lowercase registry short name. Pass --rendered-provider-name PCD to tfplugindocs (in `make generate` and the CI docs job) so the human-facing provider name renders as PCD. Resource/data-source type names (pcd_*) and the registry address platform9/pcd are unchanged. Docs-only.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Capitalizes the provider name in generated documentation so the Registry shows "PCD Provider" instead of "pcd Provider", and resource page titles read "… - PCD" instead of "… - pcd".
Implemented by passing
--rendered-provider-name PCDtotfplugindocs, wired into bothmake generateand the CI docs job so they stay in sync. Docs regenerated accordingly (78 pages).Why
tfplugindocsdefaults the rendered provider name to the lowercase registry short name (pcd), which reads as unpolished in the overview heading and page<title>s.Scope / what does NOT change
pcd_networking_network, …) stay lowercase — verified 0 type names were altered.platform9/pcdis unchanged (immutable; that's the published source).aws,google,azurerm) and not controllable from the repo.Rollout
Docs-only. Appears on the Registry once a release tag containing it is published (proposed v0.1.2).