docs: use entry-point name in auto-generated CLI examples#259
Open
amaechiabuah wants to merge 2 commits intomainfrom
Open
docs: use entry-point name in auto-generated CLI examples#259amaechiabuah wants to merge 2 commits intomainfrom
amaechiabuah wants to merge 2 commits intomainfrom
Conversation
Contributor
|
Task linked: DUPLO-33001 Issue: Incorrect command aws_secret list in docs |
Contributor
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
duplodavid
approved these changes
Apr 22, 2026
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
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.
Describe Changes
Auto-generated resource doc pages used the class-name-derived kind (e.g.,
awssecretforDuploAwsSecret) when rendering CLI usage examples, instead of the actual entry-point command name (aws_secret). Four resources shipped docs telling customers to run non-existent commands:DuploAwsSecretawssecretaws_secretDuploParamparamssm_paramDuploEcsServiceecsserviceecsPersistentVolumeClaimpersistentvolumeclaimpvcFix
scripts/mkdocs.pynow emitscommand: <entry-point-name>in each generated page's frontmatter, alongside the existingkind:field.DuploResourceV2/DuploResourceV3docstrings forlist/find/delete/create/applynow render CLI examples asduploctl {{command}} <sub>instead ofduploctl {{kind | lower}} <sub>.{{kind | lower}}references used for.yamltest-data file paths (e.g.,src/tests/data/awssecret.yaml) were intentionally left alone since they match existing file names.Docs-only change; verified with
mkdocs buildthat the rendered HTML for all four affected pages now shows the correct CLI command and no occurrences of the old wrong names.Link to Issues
PR Review Checklist