Update ToC in TaskRuns documentation #4265

nbaudis · 2021-09-28T20:33:33Z

Changes

Updating the ToC in the TaskRuns documentation which had some headings missing. Additionally, the following smaller improvements were made:

Fixed quote instead of backtick in ServiceAccount credentials heading
Moved overview one level deeper to be consistent with the rest of the documentation (see docs/pipelines.md and docs/tasks.md)
Added  and  tags for inplace ToC updates in the future

/kind documentation

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Docs included if any changes are user facing
Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

NONE

linux-foundation-easycla · 2021-09-28T20:33:36Z

The committers are authorized under a signed CLA.

✅ Nikolai Baudis (922b87f, d46af11, f5a6330, 24e9d45)

tekton-robot · 2021-09-28T20:33:48Z

Hi @nbaudis. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

pritidesai · 2021-09-28T21:40:48Z

/ok-to-test

pritidesai · 2021-09-28T21:47:40Z

docs/taskruns.md

  - [Specifying a `Pod` template](#specifying-a-pod-template)
  - [Specifying `Workspaces`](#specifying-workspaces)
  - [Specifying `Sidecars`](#specifying-sidecars)
  - [Specifying `LimitRange` values](#specifying-limitrange-values)
-  - [Configuring the failure timeout](#configuring-the-failure-timeout)
+- [Configuring the failure timeout](#configuring-the-failure-timeout)


thanks @nbaudis for the updates 🙏

This can be placed under Configuring a TaskRun. Please update the section header so that it aligns with the other "Specifying*" titles.

pritidesai · 2021-09-28T21:50:32Z

docs/taskruns.md

- [Debugging a `TaskRun`](#debugging-a-taskrun)
- [Events](events.md#taskruns)
- [Running a TaskRun Hermetically](hermetic.md)
+  - [Debugging a `TaskRun`](#debugging-a-taskrun)


Also, please move this out of the Cancelling a TaskRun section, such that, both are on same level:

Cancelling a TaskRun
Debugging a TaskRun

pritidesai · 2021-09-28T21:54:22Z

There are two sections missing from ToC:

Both are referencing other files, can we please add it back for folks if they are relying on those links.

nbaudis · 2021-09-28T22:41:59Z

Thanks a lot for your comments @pritidesai!

I've corrected the indentation for the two sections and added the two links again. Maybe these links should be placed somewhere outside the ToC so they don't disappear again, but I'm not sure since maybe people rely on them being at the top of the documentation.

afrittoli · 2021-09-29T09:42:51Z

/test pull-tekton-pipeline-alpha-integration-tests

ghost · 2021-09-29T11:40:28Z

docs/taskruns.md

@@ -509,7 +517,7 @@ spec:
 ```


-### Debugging a `TaskRun`
+## Debugging a `TaskRun`

 #### Breakpoint on Failure


We should probably drop the heading on this to 3 # to bring it in line with its changed parent heading. Same for #### Debug Environment below - should now be ### Debug Environment.

Thanks @sbwsg, you are right. I've changed the levels of the two headings.

This fixes missing and changed entries in the ToC according to the section headings. Some minor improvements were made, including moving some headings to their correct depth.

nbaudis · 2021-09-29T12:39:35Z

squashed all commits into 1789763

pritidesai

thank you @nbaudis 👍

tekton-robot · 2021-09-29T13:14:56Z

[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:

~~OWNERS~~ [pritidesai]

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

ghost · 2021-09-29T13:28:58Z

docs/taskruns.md

  - [Monitoring `Results`](#monitoring-results)
 - [Cancelling a `TaskRun`](#cancelling-a-taskrun)
 - [Debugging a `TaskRun`](#debugging-a-taskrun)
+    - [Breakpoint on Failure](#breakpoint-on-failure)


Looks like the toc needs to be re-generated after changing the heading level of these two. They're still indented one level too far I think.

Hey @sbwsg I think it shows all aligned:

I see, the - [Breakpoint on Failure](#breakpoint-on-failure) is one level indented further compared to - [Monitoring Results](#monitoring-results).

Ah OK, looks like it renders fine even though the markdown spacing is different.

ghost · 2021-09-29T13:36:26Z

/lgtm

tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. labels Sep 28, 2021

tekton-robot requested review from imjasonh and a user September 28, 2021 20:33

tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 28, 2021

tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 28, 2021

pritidesai reviewed Sep 28, 2021

View reviewed changes

priyawadhwa mentioned this pull request Sep 28, 2021

Make sure images stored in registry mirrors are signed #4262

Merged

5 tasks

ghost reviewed Sep 29, 2021

View reviewed changes

Update TaskRuns documentation ToC

1789763

This fixes missing and changed entries in the ToC according to the section headings. Some minor improvements were made, including moving some headings to their correct depth.

nbaudis force-pushed the improve-taskruns-docs branch from 8c7443b to 1789763 Compare September 29, 2021 12:38

pritidesai approved these changes Sep 29, 2021

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 29, 2021

ghost reviewed Sep 29, 2021

View reviewed changes

tekton-robot assigned ghost Sep 29, 2021

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 29, 2021

tekton-robot merged commit 43a5891 into tektoncd:main Sep 29, 2021

nbaudis deleted the improve-taskruns-docs branch September 30, 2021 21:22

pritidesai mentioned this pull request Oct 4, 2021

fix a few links in the development file under ... #4256

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update ToC in TaskRuns documentation #4265

Update ToC in TaskRuns documentation #4265

nbaudis commented Sep 28, 2021

linux-foundation-easycla bot commented Sep 28, 2021 •

edited

tekton-robot commented Sep 28, 2021

pritidesai commented Sep 28, 2021

pritidesai Sep 28, 2021

pritidesai Sep 28, 2021

pritidesai commented Sep 28, 2021

nbaudis commented Sep 28, 2021

afrittoli commented Sep 29, 2021

ghost Sep 29, 2021

nbaudis Sep 29, 2021

nbaudis commented Sep 29, 2021

pritidesai left a comment

tekton-robot commented Sep 29, 2021

ghost Sep 29, 2021

pritidesai Sep 29, 2021

pritidesai Sep 29, 2021

ghost Sep 29, 2021

ghost commented Sep 29, 2021

Update ToC in TaskRuns documentation #4265

Update ToC in TaskRuns documentation #4265

Conversation

nbaudis commented Sep 28, 2021

Changes

Submitter Checklist

Release Notes

linux-foundation-easycla bot commented Sep 28, 2021 • edited

tekton-robot commented Sep 28, 2021

pritidesai commented Sep 28, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pritidesai commented Sep 28, 2021

nbaudis commented Sep 28, 2021

afrittoli commented Sep 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nbaudis commented Sep 29, 2021

pritidesai left a comment

Choose a reason for hiding this comment

tekton-robot commented Sep 29, 2021

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

ghost commented Sep 29, 2021

linux-foundation-easycla bot commented Sep 28, 2021 •

edited