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 step by step walkthrough tutorial #22

Closed
bobcatfish opened this issue Sep 8, 2018 · 3 comments
Closed

Create step by step walkthrough tutorial #22

bobcatfish opened this issue Sep 8, 2018 · 3 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@bobcatfish
Copy link
Collaborator

Expected Behavior

When someone wants to ramp up on this project, they should be able to follow along with a tutorial that explains to them how to create their own pipelines and interact with them.

We can initially cover a simple pipeline, e.g. the example kritis pipeline.

Requirements

  • It should be possible to:
    1. Start from no pipeline or tasks at all
    2. Gradually build up a complete set of Pipelines, Tasks, PipelineParams
    3. Manually invoke a Task by creating a TaskRun
    4. Manually invoke a Pipeline by creating a PipelineRun
  • There should be tests that cover this.
  • The tutorial should cover actually deploying these to a k8s cluster using kubectl (e.g. like in the DEVELOPMENT.md).
  • The solution should be available (could be link to https://github.com/knative/build-pipeline/tree/master/examples#example-pipelines if we use those examples as-is)

Initially this would not actually do anything, but as we start adding actual functionality we can build this up over time.

Additional Info

If you are feeling really ambitious, you could also cover the more complex guestbook pipeline which has both fan-in and fan-out.

@bobcatfish bobcatfish added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Sep 8, 2018
@bobcatfish
Copy link
Collaborator Author

Since #143 might not be fixed, we should create a pipeline that builds and deploys an image.

We can iteratively add test results and logs later as we add functionality.

@bobcatfish bobcatfish added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 12, 2018
bobcatfish referenced this issue in bobcatfish/pipeline Oct 26, 2018
Moved docs out of the README into other docs, such as `using.md` (which
is only just barely a start at usage docs, lots left to do here!)
Hopefully in #22 we could expand on these a bit.

The README which we did have was created specifically for the folks
working on the Build CRD to understand how this project related to the
Build CRD; but if a person comes to this project not already knowing
about the Build CRD it's pretty confusing.

Removed the `status` sections from our run examples since folks wouldn't
add those manually. That was only there b/c initially all we had were
examples, which we had to build the real thing from.

Fixes #136
knative-prow-robot pushed a commit that referenced this issue Oct 26, 2018
Moved docs out of the README into other docs, such as `using.md` (which
is only just barely a start at usage docs, lots left to do here!)
Hopefully in #22 we could expand on these a bit.

The README which we did have was created specifically for the folks
working on the Build CRD to understand how this project related to the
Build CRD; but if a person comes to this project not already knowing
about the Build CRD it's pretty confusing.

Removed the `status` sections from our run examples since folks wouldn't
add those manually. That was only there b/c initially all we had were
examples, which we had to build the real thing from.

Fixes #136
@bobcatfish bobcatfish added this to the 0.0.1 Alpha release milestone Nov 3, 2018
@nader-ziada
Copy link
Member

/assign

nader-ziada added a commit to nader-ziada/pipeline that referenced this issue Dec 11, 2018
- issue 22 [tektoncd#22]
- steps to building task, running it then using it in a pipeline
nader-ziada added a commit to nader-ziada/pipeline that referenced this issue Dec 12, 2018
- issue 22 [tektoncd#22]
- steps to building task, running it then using it in a pipeline

Signed-off-by: Nader Ziada <nziada@pivotal.io>
nader-ziada added a commit to nader-ziada/pipeline that referenced this issue Dec 12, 2018
- issue 22 [tektoncd#22]
- steps to building task, running it then using it in a pipeline

Signed-off-by: Nader Ziada <nziada@pivotal.io>
knative-prow-robot pushed a commit that referenced this issue Dec 12, 2018
- issue 22 [#22]
- steps to building task, running it then using it in a pipeline

Signed-off-by: Nader Ziada <nziada@pivotal.io>
@bobcatfish
Copy link
Collaborator Author

Thanks for taking care of this @pivotal-nader-ziada !! 🎉

vdemeester referenced this issue in openshift/tektoncd-pipeline Apr 5, 2019
Moved docs out of the README into other docs, such as `using.md` (which
is only just barely a start at usage docs, lots left to do here!)
Hopefully in #22 we could expand on these a bit.

The README which we did have was created specifically for the folks
working on the Build CRD to understand how this project related to the
Build CRD; but if a person comes to this project not already knowing
about the Build CRD it's pretty confusing.

Removed the `status` sections from our run examples since folks wouldn't
add those manually. That was only there b/c initially all we had were
examples, which we had to build the real thing from.

Fixes #136
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants