Update docs such that they can be used in knative/docs #460

bobcatfish · 2019-02-01T02:53:41Z

In version 0.4 of knative, we'd like to release build-pipeline, which
means that the docs repo (https://github.com/knative/docs) should talk
about build-pipeline.

I think it's important to make sure that docs are updated with the code,
so I propose we have living versions of these docs in this repo, and
every time we release, we copy the docs into the knative/docs repo, so
that this repo has the correct docs at HEAD and knative/docs has the
correct docs as of the latest release. (How we want to deal with docs
for previous releases will have to be another story!)

In this PR, I've gone through the knative docs for
build and shaped our
existing docs to be similar, which meant:

Taking content out of using.md and splitting it into a file for each
type of CRD
Adding reference docs for the CRD fields (fixes Create reference docs #193)
Most of concepts.md and some of using.md became the README file which
lives at the top level of the docs dir here and hopefully the new
pipelines dir in knative/docs

This also meant gaining a lot of docs by taking existing Build docs and
updating them to talk about pipelines (e.g. docs about auth)

Fixes #304

Reviewers: I've probably missed some link, some references to Build, and some k8s standards. Your nits are very welcome!

(After we finish and merge this PR, I'll open a PR in knative/docs to add these docs there. If they request doc changes I'll backport them here)

shashwathi

This is awesome work @bobcatfish 👍

knative-prow-robot · 2019-02-01T19:46:44Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bobcatfish, shashwathi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [bobcatfish,shashwathi]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

nader-ziada

@bobcatfish awesome docs, thank you for doing that! 🎉

I left a few comments about some links not working, let me know if you want to get this in and iterate on the comments

nader-ziada · 2019-02-01T19:26:15Z

docs/pipelines.md

+- Optional:
+  - [`resources`](#declared-resources) - Specifies which [`PipelineResources`](resources.md)
+    of which types the `Pipeline` will be using in its [Tasks](#pipeline-tasks)
+  - [`timeout`](#timeout) - Specifies timeout after which the `Pipeline` will fail.


this link doesn't go anywhere

nader-ziada · 2019-02-01T19:26:48Z

docs/pipelines.md

+        name: build-push
+```
+
+[Declared `PipelineResources`](#declared-resources) can be given to `Task`s in the `Pipeline` as


This link doesn't go anywhere

hmmm I think this one works 🤔

nader-ziada · 2019-02-01T19:29:23Z

docs/pipelines.md

+The resource `my-image` is expected to be given to the `deploy-app` `Task` from
+the `build-app` `Task`. This means that the `PipelineResource` `my-image` must
+also be declared as an output of `build-app`.
+


is that the same as build-the-image in the example above?

whoa this block seems completely out of place 😊

nader-ziada · 2019-02-01T19:31:09Z

docs/pipelines.md

+the `build-app` `Task`. This means that the `PipelineResource` `my-image` must
+also be declared as an output of `build-app`.
+
+For implementation details, see [the developer docs](docs/developers/README.md).


this link gives a 404 😲

im actually gonna remove this b/c the developer dir won't be copied over to knative/docs...

nader-ziada · 2019-02-01T19:35:29Z

docs/tasks.md

+    authentication information.
+  - [`volumes`](#volumes) - Specifies one or more volumes that you want to make
+    available to your build.
+  - [`timeout`](#timeout) - Specifies timeout after which the `Pipeline` will fail.


This link doesn't go anywhere

nader-ziada · 2019-02-01T19:35:44Z

docs/tasks.md

+  - [`inputs`](#inputs) - Specifies parameters and [`PipelineResources`](resources.md)
+    needed by your `Task`
+  - [`outputs`](#outputs) - Specifies [`PipelineResources`](resources.md) needed by your `Task`
+  - [`serviceAccount`](#service-account) - Specifies a `ServiceAccount`


This link doesn't go anywhere

whoops, thats only in taskrun! 😇

nader-ziada · 2019-02-01T19:37:51Z

docs/tasks.md

+A `Task` can declare the inputs it needs, which can be either or both of:
+
+* [`parameters`](#parameters)
+* [`input resources](#input-resources)


extra character before the word input

nader-ziada · 2019-02-01T19:42:48Z

docs/tasks.md

+
+- [Example of image building and pushing](#example-task)
+- [Mounting extra volumes](#using-an-extra-volume)
+- [Authenticating with `ServiceAccount`](#using-a-serviceaccount)


this link doesn't go anywhere

nader-ziada · 2019-02-01T19:48:38Z

docs/container-contract.md

+        value: "world"
+```
+
+_See [the installation guide](installing.md) if you would like to


both links here give 404

oh yeah, we won't have that till we have #385 🤔

In version 0.4 of knative, we'd like to release build-pipeline, which means that the docs repo (https://github.com/knative/docs) should talk about build-pipeline. I think it's important to make sure that docs are updated with the code, so I propose we have living versions of these docs in this repo, and every time we release, we copy the docs into the knative/docs repo, so that this repo has the correct docs at HEAD and knative/docs has the correct docs as of the latest release. (How we want to deal with docs for previous releases will have to be another story!) In this PR, I've gone through [the knative docs for build](https://github.com/knative/docs/tree/master/build) and shaped our existing docs to be similar, which meant: * Taking content out of using.md and splitting it into a file for each type of CRD * Adding reference docs for the CRD fields (fixes tektoncd#193) * Most of concepts.md and some of using.md became the README file which lives at the top level of the `docs` dir here and hopefully the new `pipelines` dir in knative/docs This also meant gaining a lot of docs by taking existing Build docs and updating them to talk about pipelines (e.g. docs about auth) Fixes tektoncd#304

bobcatfish · 2019-02-02T02:43:37Z

Thanks for noticing all those details @pivotal-nader-ziada !! Ready for another look :D

nader-ziada · 2019-02-02T04:20:18Z

/test pull-knative-build-pipeline-integration-tests

nader-ziada · 2019-02-02T04:58:20Z

looks good 👍

/lgtm

Releasing release.yaml v0.14.1

googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Feb 1, 2019

knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 1, 2019

knative-prow-robot requested review from ericKlawitter and shashwathi February 1, 2019 02:53

knative-prow-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 1, 2019

bobcatfish mentioned this pull request Feb 1, 2019

Correcting usage link to point to using.md #461

Closed

shashwathi approved these changes Feb 1, 2019

View reviewed changes

nader-ziada reviewed Feb 1, 2019

View reviewed changes

bobcatfish force-pushed the knative_docs branch from d8a1ad1 to 39157cc Compare February 2, 2019 02:43

knative-prow-robot assigned nader-ziada Feb 2, 2019

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 2, 2019

knative-prow-robot merged commit c579a78 into tektoncd:master Feb 2, 2019

bobcatfish mentioned this pull request Feb 12, 2019

copy the labels from Task ->TaskRun to the generated Pod #458

Closed

mchmarny unassigned nader-ziada Mar 7, 2019

piyush-garg pushed a commit to piyush-garg/pipeline that referenced this pull request Jul 14, 2020

Merge pull request tektoncd#460 from piyush-garg/release-yaml-v0.14.1

28cd6d5

Releasing release.yaml v0.14.1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs such that they can be used in knative/docs #460

Update docs such that they can be used in knative/docs #460

bobcatfish commented Feb 1, 2019

shashwathi left a comment

knative-prow-robot commented Feb 1, 2019

nader-ziada left a comment

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

nader-ziada Feb 1, 2019

bobcatfish Feb 2, 2019

bobcatfish commented Feb 2, 2019

nader-ziada commented Feb 2, 2019

nader-ziada commented Feb 2, 2019

Update docs such that they can be used in knative/docs #460

Update docs such that they can be used in knative/docs #460

Conversation

bobcatfish commented Feb 1, 2019

shashwathi left a comment

Choose a reason for hiding this comment

knative-prow-robot commented Feb 1, 2019

nader-ziada left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bobcatfish commented Feb 2, 2019

nader-ziada commented Feb 2, 2019

nader-ziada commented Feb 2, 2019