tektoncd / tektoncd/cli

Generate Markdown + Asciidoc for Tasks and Pipelines

Open
#2,512 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature
Dominant language
Go
Stars
461
Forks
277
Avg merge
16h 48m
Merged PRs (30d)
95

Description

Feature request

Add ability for tkn to generate a Markdown representation of any Task, Pipeline, or group of such objects (ex: hub, bundle).

Use case
  • Generate Markdown docs that can be rendered into HTML with a static site generator, such as hugo.
  • Generate asciidoc docs that can be rendered to HTML by a supported platform.
  • Auto-generate the READMEs for task/pipeline catalogs.

These would likely need to provide a default template that can be configured/modified by an end user. crd-ref-docs provides a similar mechanism.

UI Example
tkn bundle doc <bundle> [task/pipeline] [name] --output=markdown
tkn pipeline doc <name> -o markdown
tkn task doc <name> -o markdown

Note: there are some inconsistencies in command naming conventions for hub that make this a bit more challenging.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing tkn task, pipeline, and bundle command entry points, including the inconsistent hub command naming. Define the supported object groups, Markdown and Asciidoc output modes, and configurable default-template behavior; done means these commands can generate catalog-ready documentation for the requested objects.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.