You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Users of Triggers should have a place to look for docs on each CRD that they'll be interacting with.
Actual behavior
We have no docs, but in #10 we'll be adding the types. The only docs we have at the moment are in the design doc.
Additional info
One decision we may want to make at this point is whether we want to have a markdown file per type, the way that Tekton Pipelines does, or if we want this kind of documentation to live with the code and primarily be visible at https://godoc.org/.
Expected behavior
Users of Triggers should have a place to look for docs on each CRD that they'll be interacting with.
Actual behavior
We have no docs, but in #10 we'll be adding the types. The only docs we have at the moment are in the design doc.
Additional info
One decision we may want to make at this point is whether we want to have a markdown file per type, the way that Tekton Pipelines does, or if we want this kind of documentation to live with the code and primarily be visible at https://godoc.org/.
If we decide to rely on godocs, we need to have more carefully curated godocs than https://godoc.org/github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1 does, specifically:
It may also be harder to version godocs and present them nicely in an interface such as https://knative.dev/docs/ or https://skaffold.dev/docs/ (which i think both use netlify?)
The text was updated successfully, but these errors were encountered: