"The Tekton APIs" link in https://tekton.dev/docs/overview/ links to k8s CRD page

[naphatkrit]

Today, "The Tekton APIs" link just links out to the k8s CRD page. Was this supposed to link somewhere else? Are the APIs just referring to the go APIs for creating tekton CRDs as golang objects? Or are there other programmatic APIs somewhere else?

[AlanGreene]

Thanks for the issue @naphatkrit and apologies for the delay responding.

We discussed this on the Docs WG today when reviewing potential issues for new contributors.

The APIs in this case are referring to the Kubernetes CRDs provided by the Tekton Pipelines project. We have another issue to make the API reference for these available on the website: #117, and there has been some recent progress on generating the required content: tektoncd/pipeline#1250

Once that's available it would probably make sense to point to it instead of the Kubernetes docs.

A link to the go APIs would also be useful although I think that's probably better suited to some more advanced docs rather than the overview.

[naphatkrit]

Great, thank you!

…

On Tue, Apr 26, 2022 at 6:48 PM Alan Greene ***@***.***> wrote: Thanks for the issue @naphatkrit <https://github.com/naphatkrit> and apologies for the delay responding. We discussed this on the Docs WG today when reviewing potential issues for new contributors. The APIs in this case are referring to the Kubernetes CRDs provided by the Tekton Pipelines project. We have another issue to make the API reference for these available on the website: #117 <#117>, and there has been some recent progress on generating the required content: tektoncd/pipeline#1250 <tektoncd/pipeline#1250> Once that's available it would probably make sense to point to it instead of the Kubernetes docs. A link to the go APIs would also be useful although I think that's probably better suited to some more advanced docs rather than the overview. — Reply to this email directly, view it on GitHub <#363 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGR5LIFHCHVUQGWIP6LBI3VHAUANANCNFSM5R3FYBOA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[tekton-robot]

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.

[lbernick]

Tekton generated API references is now available for Pipelines here

[lbernick]

This also looks like a duplicate of #117?

[AlanGreene]

Related but not a duplicate IMO. #117 covers publishing the content of the API references on the website. The content is available for Pipelines now at the location you referenced above.

This issue is specifically related to the link in the overview doc which currently points to Kubernetes docs. Pointing to these new Pipeline API reference docs would definitely be useful but doesn't cover the Triggers portion yet. That paragraph could do with being updated to clarify that the APIs being discussed are the set of CRDs defined by Tekton. It's mentioned briefly under the 'What are the components of Tekton?' section on that page but could probably benefit from some elaboration.

[tekton-robot]

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]

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]

@tekton-robot: Closing this issue.

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.