tektoncd / tektoncd/website

Publish CLI references

Open
#118 18 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted kind/documentation lifecycle/frozen
Dominant language
CSS
Stars
70
Forks
176
PR merge metrics
No merged PRs in 30d

Description

As part of tekton.dev documentation, we should publish the CLI references of tkn

See https://knative.dev/docs/reference/client/ and https://github.com/tektoncd/cli/tree/master/docs/cmd (reference docs are already generated, we just need to sync them and "present" them)

/kind documentation

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

Start with the existing CLI references in tektoncd/cli/docs/cmd and compare their presentation with the Knative client reference at knative.dev/docs/reference/client/. Then inspect the Tekton website documentation structure to determine where the generated tkn references belong; done means the CLI references are synced and publicly presented.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.