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

docs: Update references to examples from v1beta1 to v1 #7050

Merged
merged 1 commit into from
Aug 15, 2023
Merged

docs: Update references to examples from v1beta1 to v1 #7050

merged 1 commit into from
Aug 15, 2023

Conversation

HamzaMateen
Copy link
Contributor

In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1, this commit addresses broken links in our documentation. The changes involve updating references to examples under the v1beta1 API version to instead point to the v1 API version. Additionally, certain features that transitioned from alpha to beta within the v1 API required corresponding updates to their references.

This change ensures that the documentation accurately reflects the current state of the project, eliminating broken links and inconsistencies. The goal is to improve the overall user experience and provide accurate information.

Fixes #6908

Changes

  • Updated references to examples from v1beta1 to v1 in the following documentation files:
    • docs/api-spec.md
    • docs/auth.md
    • docs/developers/api-versioning.md
    • docs/matrix.md
    • docs/pipelineruns.md
    • docs/pipelines.md
    • docs/taskruns.md
    • docs/tasks.md
    • docs/workspaces.md

Submitter Checklist

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

  • [ x] 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
  • [ x] Follows the commit message standard
  • [ x] Meets the Tekton contributor standards (including functionality, content, code)
  • [ x] 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

@HamzaMateen
docs: Update references to examples from v1beta1 to v1
9c0aee2 
In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1,
this commit addresses broken links in our documentation. The changes involve updating
references to examples under the v1beta1 API version to instead point to the v1 API version.
Additionally, certain features that transitioned from alpha to beta within the v1 API required
corresponding updates to their references.

This change ensures that the documentation accurately reflects the current state of the project,
eliminating broken links and inconsistencies. The goal is to improve the overall user experience
and provide accurate information.

Fixes tektoncd#6908
@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Aug 12, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 12, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: HamzaMateen / name: Hamza Mateen (9c0aee2)

@tekton-robot
Copy link
Collaborator

Hi @HamzaMateen. 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.

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 12, 2023
@HamzaMateen
Copy link
Contributor Author

HamzaMateen commented Aug 12, 2023 •
edited
Loading

/kind documentation

khrm
khrm reviewed Aug 14, 2023
View reviewed changes
Copy link
Contributor

@khrm khrm left a comment

Choose a reason for hiding this comment

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

/ok-to-test

@tekton-robot 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 Aug 14, 2023
@khrm
Copy link
Contributor

khrm commented Aug 14, 2023

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

@khrm: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-beta-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

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.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 14, 2023
@vdemeester
Copy link
Member

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 14, 2023
@JeromeJu
Copy link
Member

JeromeJu commented Aug 15, 2023 •
edited
Loading

/lgtm
Thanks @HamzaMateen

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 15, 2023
@tekton-robot tekton-robot merged commit fff25b1 into tektoncd:main Aug 15, 2023
2 checks passed
@afrittoli afrittoli mentioned this pull request Sep 25, 2023
Closed
@vdemeester
Copy link
Member

/cherry-pick release-v0.50.x

@tekton-robot
Copy link
Collaborator

@vdemeester: new pull request created: #7202

In response to this:

/cherry-pick release-v0.50.x

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.

@tekton-robot tekton-robot mentioned this pull request Oct 11, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@khrm khrm khrm left review comments

@vdemeester vdemeester vdemeester approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

Assignees

@JeromeJu JeromeJu

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@HamzaMateen @tekton-robot @khrm @vdemeester @JeromeJu