Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the tkn reference to the CLI docs #206

Closed
wants to merge 1 commit into from

Conversation

afrittoli
Copy link
Member

Changes

Add the doc/cmd folder to add the tkn reference docs to the CLI
documentation. Add support for defaulting page title and link
title to the filename, if not set, which works OK for tkn.

Fixes #118

Signed-off-by: Andrea Frittoli [email protected]

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

See the contribution guide
for more details.

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 9, 2020
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign afrittoli
You can assign the PR to them by writing /assign @afrittoli in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 9, 2020
@AlanGreene
Copy link
Member

AlanGreene commented Nov 11, 2020

Should the 'What's Next?' link on the main CLI page link to these docs instead of the GitHub repo?

Update: Also is this new section expected?

tkn
The `tkn` CLI reference

image

It seems like they're both essentially trying to link to the same content, so probably only need to keep one of them.

@afrittoli
Copy link
Member Author

Should the 'What's Next?' link on the main CLI page link to these docs instead of the GitHub repo?

Yeah, good point, that's hosted on tektoncd/cli, so we could change it there

Update: Also is this new section expected?

tkn
The `tkn` CLI reference

Yeah, this new section is added as part of this PR, it contains the tkn reference docs

image

It seems like they're both essentially trying to link to the same content, so probably only need to keep one of them.

@chmouel
Copy link
Member

chmouel commented Nov 17, 2020

thanks for doing this, What do we need to change in our docs so we can get something like "TektonCD CLI" instead of tkn ?

@afrittoli
Copy link
Member Author

thanks for doing this, What do we need to change in our docs so we can get something like "TektonCD CLI" instead of tkn ?

That's configured here: https://github.com/tektoncd/website/pull/206/files#diff-d25f162c4c374d7c8bbdf20d08628221b8bc1ea74e4cb02a12986acf01d68159R47

I will amend the configuration in this PR in a moment.
The github org was called tektoncd because tekton was already taken, but the project is called Tekton, so perhaps I would use "Tekton CLI".

Add the doc/cmd folder to add the tkn reference docs to the CLI
documentation. Add support for defaulting page title and link
title to the filename, if not set, which works OK for tkn.

Fixes tektoncd#118

Signed-off-by: Andrea Frittoli <[email protected]>
@chmouel
Copy link
Member

chmouel commented Nov 17, 2020

cool thank you!

Base automatically changed from master to main February 3, 2021 16:10
@tekton-robot
Copy link

@afrittoli: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 20, 2021
@tekton-robot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 21, 2021
@tekton-robot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

@tekton-robot tekton-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jun 20, 2021
@tekton-robot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

@tekton-robot
Copy link

@tekton-robot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish CLI references
4 participants