Skip to content

Conversation

@enrichman
Copy link
Collaborator

@enrichman enrichman commented Dec 30, 2025

This PR adds an automation to create an AsciiDoc k3kcli.adoc file with the cli documentation.

This file has the same structure/format of the k3kcli.adoc file used in the rancher/k3k-product-docs repo.

To achieve this the docs Makefile target was split in two, adding a docs-crds and a docs-cli target. The docs-cli uses a script with pandoc to merge and create the k3kcli.adoc file, with a custom Lua script to handle some tweaks from the Cobra generated Markdown (i.e. removing the SEE ALSO links to the different pages, since we are using a single file).

This PR also updates some of the commands Short descriptions to match the updates made from the Doc team.

@enrichman enrichman self-assigned this Dec 30, 2025
@enrichman enrichman linked an issue Dec 30, 2025 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Dec 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.65%. Comparing base (fc6bced) to head (7a1bdb0).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #597      +/-   ##
==========================================
- Coverage   60.80%   60.65%   -0.16%     
==========================================
  Files          55       55              
  Lines        5294     5294              
==========================================
- Hits         3219     3211       -8     
- Misses       1775     1779       +4     
- Partials      300      304       +4     
Flag Coverage Δ
cli 54.13% <100.00%> (ø)
controller 56.80% <0.00%> (-0.03%) ⬇️
e2e 56.80% <0.00%> (-0.03%) ⬇️
unit 37.63% <0.00%> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@enrichman enrichman merged commit c16eae9 into rancher:main Jan 7, 2026
9 checks passed
@enrichman enrichman deleted the 596-cli-docs branch January 7, 2026 10:16
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.

Automate k3kcli Markdown to AsciiDoc generation

3 participants