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

Create docs for each type #14

Closed
bobcatfish opened this issue Jun 23, 2019 · 2 comments · Fixed by #24
Closed

Create docs for each type #14

bobcatfish opened this issue Jun 23, 2019 · 2 comments · Fixed by #24
Assignees
Milestone

Comments

@bobcatfish
Copy link
Collaborator

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?)

@vtereso
Copy link

vtereso commented Jul 10, 2019

/assign

@vtereso
Copy link

vtereso commented Jul 10, 2019

I will approach this in the Tekton way with a markdown for each.

@vtereso vtereso mentioned this issue Jul 18, 2019
3 tasks
@bobcatfish bobcatfish added this to the Triggers 0.1 milestone Aug 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants