Revamp Tekton developer docs for /tekton paths. #4238
Conversation
tekton-robot
added
do-not-merge/release-note-label-needed
|
/release-note-none |
tekton-robot
added
release-note-none
|
/kind documentation |
tekton-robot
added
the
kind/documentation
| |-- termination | ||
| `-- tools | ||
| |-- 0 | ||
| `-- entrypoint |
There was a problem hiding this comment.
are these backticks part of the directory layout? https://github.com/tektoncd/pipeline/blob/e084563cfc926418b7211f9388857bbbf26e8bf2/docs/developers/README.md#tekton
@sbwsg has explained some of the layout and files in a video here. While we are revamping the developers doc, can we include a link to the video recording?
There was a problem hiding this comment.
are these backticks part of the directory layout?
The backticks are the formatting of tree as the opposite of / to show that the end of the directory. My guess is was a style choice since `- matches the horizontal line height instead of \-
@sbwsg has explained some of the layout and files in a video here. While we are revamping the developers doc, can we include a link to the video recording?
There's a few useful videos there, so added a link to the top of the page!
The content is largely the same, this just reorganizes some of the content into a table and provides a sample filetree to show what files/directories are present. Additionally, this adds docs for the following directories that were not already present: - /tekton/downward - /tekton/creds Other diffs are formating caused by `prettier --prose-wrap always`
wlynch
force-pushed
the
tekton-dir-docs
branch
from
e084563 to
15de24e
Compare
| @@ -3,6 +3,10 @@ | |||
| This document is aimed at helping maintainers/developers of project understand | |||
| the complexity. | |||
|
|
|||
| We also recommend checking out the | |||
| [Teknical Tekton](https://www.youtube.com/channel/UCUEuKDqyRnGFCE7FpainSpQ) | |||
| channel for training and tutorials on Tekton! | |||
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pritidesai 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:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
|
Thanks! This is much clearer. /lgtm |
Changes
The content is largely the same, this just reorganizes some of the
content into a table and provides a sample filetree to show what
files/directories are present.
Additionally, this adds docs for the following directories that were missing:
Other diffs are formatting caused by
prettier --prose-wrap always/kind docs
/cc @bobcatfish
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes