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.

Sign up for GitHub

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

Jump to bottom

Update link to section on overriding task requests #8650

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update link to section on overriding task requests #8650

wants to merge 1 commit into from

Conversation

samdoran
Copy link

@samdoran samdoran commented Mar 14, 2025 •
edited
Loading

Changes

Update the link to the section on overriding task resource requests and use the API v1 terms in the TOC.

Submitter Checklist

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

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Mar 14, 2025
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

CLA Not Signed

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign pritidesai after the PR has been reviewed.
You can assign the PR to them by writing /assign @pritidesai in a comment when ready.

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

Needs approval from an approver in each of these files:

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

@tekton-robot tekton-robot requested a review from dibyom March 14, 2025 20:59
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 14, 2025
@tekton-robot tekton-robot requested a review from jerop March 14, 2025 20:59
@samdoran
Copy link
Author

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 14, 2025
@waveywaves
Copy link
Member

waveywaves commented Mar 25, 2025 •
edited
Loading

We need some kind of linter on the docs to check if the links resolve 🤔

waveywaves
waveywaves suggested changes Mar 25, 2025
View reviewed changes
docs/taskruns.md
- [`stepOverrides`](#overriding-task-steps-and-sidecars) - Specifies configuration to use to override the `Task`'s `Step`s.
- [`sidecarOverrides`](#overriding-task-steps-and-sidecars) - Specifies configuration to use to override the `Task`'s `Sidecar`s.
- [`stepSpecs`](#configuring-task-steps-and-sidecars-in-a-taskrun) - Specifies configuration to use to override the `Task`'s `Step`s.
- [`sidecarSpecs`](#configuring-task-steps-and-sidecars-in-a-taskrun) - Specifies configuration to use to override the `Task`'s `Sidecar`s.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to have two difference examples for each stepSpecs and sidecarSpecs here instead of going to the same link

@waveywaves
Copy link
Member

waveywaves commented Mar 25, 2025 •
edited
Loading

@samdoran can you complete the CLA ?
Thank you for catching this doc issue !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@waveywaves waveywaves waveywaves requested changes

@dibyom dibyom Awaiting requested review from dibyom

@jerop jerop Awaiting requested review from jerop

Assignees
No one assigned
Labels
kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesnt merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
Tekton Community Roadmap
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@samdoran @tekton-robot @waveywaves