-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Replacing PipelineResources in tutorial #3705
Comments
/kind documentation |
Hi, I'd like to make an update. However, the entire tutorial used |
We could add as complementing to the original tutorial that way folks can compare a pipeline with and without resources. @psschwei would that work? |
@pritidesai I like the idea of including both alternatives. However, for a new user looking to get started with Tekton (which I assume is the main audience for the tutorial), would it be better to keep things simple and only present a single way of doing things? |
Sure @psschwei sounds good. How are we updating this section to replace pipeline resources? I am asking because this section refers to a task using pipeline resources to build an image. After replacing pipeline resources with the catalog tasks, it can no longer be represented as a single task instead it has to be converted to a pipeline to combine |
@pritidesai we would need to have a task that does all (the git-clone and the build). This means we wouldn't use a task from the catalog but it would work 👼🏼. |
Does it make sense to add a clone&build task to the catalog? |
I am less sure about that yet. Let's see a bit where discussions on tektoncd/community#316 and https://github.com/tektoncd/community/pull/318/files are going before 👼🏼 🙏🏼 |
Yup, I agree with @vdemeester, lets wait and see how the discussion unfolds on tektoncd/community#316 and tektoncd/community#318. @psschwei you have hit this at the right time and I am hopeful we will find a solution to it. |
+1 We need to start having folks get used to the alternatives of PipelineResources sooner. |
Adding link to TEP-0044 now that it's merged. It includes a comparison with the TEP formerly known as 0046, which was closed. |
Issues go stale after 90d of inactivity. /lifecycle stale Send feedback to tektoncd/plumbing. |
Stale issues rot after 30d of inactivity. /lifecycle rotten Send feedback to tektoncd/plumbing. |
/lifecycle frozen we still need to do this to help users migrate off pipelineresources |
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0), we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta). In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md), we decided to officially deprecate `PipelineResources`. This change announces, documents and warns about the deprecation of `PipelineResources`. Follow-on work includes: - Replace `PipelineResources` from the tutorial - tektoncd#3705 - Replace `PipelineResources` from the examples and documentation - tektoncd#4375 - Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md) and features replacing `PipelineResources` become available Closes tektoncd#4344.
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0), we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta). In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md), we decided to officially deprecate `PipelineResources`. This change announces, documents and warns about the deprecation of `PipelineResources`. Follow-on work includes: - Replace `PipelineResources` from the tutorial - tektoncd#3705 - Replace `PipelineResources` from the examples and documentation - tektoncd#4375 - Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md) and features replacing `PipelineResources` become available Closes tektoncd#4344.
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0), we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta). In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md), we decided to officially deprecate `PipelineResources`. This change announces, documents and warns about the deprecation of `PipelineResources`. Follow-on work includes: - Replace `PipelineResources` from the tutorial - tektoncd#3705 - Replace `PipelineResources` from the examples and documentation - tektoncd#4375 - Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md) and features replacing `PipelineResources` become available Closes tektoncd#4344.
When we [released Tekton Pipelines Beta in March 2020](https://github.com/tektoncd/pipeline/releases/tag/v0.11.0), we [decided not to make `PipelineResources` Beta](https://github.com/tektoncd/pipeline/blob/e76d4132ab2ecfbedc45a964f08a01022e2d4c14/docs/resources.md#why-arent-pipelineresources-in-beta). In [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md), we decided to officially deprecate `PipelineResources`. This change announces, documents and warns about the deprecation of `PipelineResources`. Follow-on work includes: - Replace `PipelineResources` from the tutorial - #3705 - Replace `PipelineResources` from the examples and documentation - #4375 - Continue updating the documentation as work progresses on [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md) and features replacing `PipelineResources` become available Closes #4344.
The staleness of such an important ticket (and easy?) makes me pause on using this project. |
I’m currently working through learning Tekton from a newcomer’s perspective including making use of workspaces. I’d love to help get the documentation updated around this topic. |
Thanks @rebelopsio I think @geriom also has some ideas in this space. |
I created an introductory tutorial last year. I'll make my priority to update it and get it merged this week. That wasn't merged because we struggled to decide where that doc fits, in the end we decided to step back and rethink the docs strategy, we (the documentation working group) came up with a roadmap, new structure and new doc guidelines to make the overall documentation experience a lot better. I'll open a bunch of issues with the proper context for every documentation item we have in mind. The idea is to have a good, friendly and educational documentation experience for the launch of pipelines v1. |
/assign geriom Geri, sounds like you are working on this currently? feel free to remove your assignment if not. |
/close |
@vdemeester: Closing this issue. In response to this:
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. |
Currently, the Pipeline tutorial uses
git
andimage
PipelineResources for Task inputs/outputs see here. As there are beta-supported alternatives for both PipelineResources (for git, for image), it might be good to update the tutorial to use these alternatives.The text was updated successfully, but these errors were encountered: