Skip to content

docs: use entry-point name in auto-generated CLI examples#259

Open
amaechiabuah wants to merge 2 commits intomainfrom
docs/template-command-name
Open

docs: use entry-point name in auto-generated CLI examples#259
amaechiabuah wants to merge 2 commits intomainfrom
docs/template-command-name

Conversation

@amaechiabuah
Copy link
Copy Markdown
Collaborator

Describe Changes

Auto-generated resource doc pages used the class-name-derived kind (e.g., awssecret for DuploAwsSecret) 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:

Class Template rendered Correct command
DuploAwsSecret awssecret aws_secret
DuploParam param ssm_param
DuploEcsService ecsservice ecs
PersistentVolumeClaim persistentvolumeclaim pvc

Fix

  • scripts/mkdocs.py now emits command: <entry-point-name> in each generated page's frontmatter, alongside the existing kind: field.
  • Base DuploResourceV2/DuploResourceV3 docstrings for list/find/delete/create/apply now render CLI examples as duploctl {{command}} <sub> instead of duploctl {{kind | lower}} <sub>.

{{kind | lower}} references used for .yaml test-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 build that 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

  • Thoroughly reviewed on local machine.
  • Have you added any tests
  • Make sure to note changes in Changelog

@zafarabbas
Copy link
Copy Markdown
Contributor

@duploctl
Copy link
Copy Markdown
Contributor

duploctl Bot commented Apr 22, 2026

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
3701 1433 39% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
src/duplocloud/resource.py 59% 🟢
TOTAL 59% 🟢

updated for commit: 0fe57ce by action🐍

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.

3 participants