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

Fixed Broken Links in Cloud Events Documentation #6517

Merged
merged 1 commit into from
Apr 11, 2023
Merged

Fixed Broken Links in Cloud Events Documentation #6517

merged 1 commit into from
Apr 11, 2023

Conversation

jsminem
Copy link
Contributor

@jsminem jsminem commented Apr 10, 2023 •
edited

Changes

Fixed Broken Links in Events Documentation

Fixes: #6423
/kind documentation

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
  • 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)
  • 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 kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesnt merit a release note. labels Apr 10, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Apr 10, 2023 •
edited

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: jsminem / name: Jasmine (c12138c)

@tekton-robot tekton-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 10, 2023
@tekton-robot
Copy link
Collaborator

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

@afrittoli
Copy link
Member

/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 Apr 11, 2023
wlynch
wlynch requested changes Apr 11, 2023
View reviewed changes
Copy link
Member

@wlynch wlynch left a comment

Choose a reason for hiding this comment

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

Thanks for making this change! Small tweak to make things work better with the in-repo docs, but otherwise LGTM!

docs/events.md Outdated
@@ -75,15 +75,15 @@ Resource |Event |Event Type
`Run` | `Succeed` | `dev.tekton.event.run.successful.v1`
`Run` | `Failed` | `dev.tekton.event.run.failed.v1`

`CloudEvents` for `Runs` are only sent when enabled in the [configuration](./install.md#configuring-cloudevents-notifications).
`CloudEvents` for `Runs` are only sent when enabled in the [configuration](https://tekton.dev/docs/installation/additional-configs/#configuring-cloudevents-notifications).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`CloudEvents` for `Runs` are only sent when enabled in the [configuration](https://tekton.dev/docs/installation/additional-configs/#configuring-cloudevents-notifications).
`CloudEvents` for `Runs` are only sent when enabled in the [configuration](./additional-configs.md#configuring-cloudevents-notifications).

docs/events.md Outdated
@@ -50,7 +50,7 @@ but the underlying `TaskRun` do.

# Events via `CloudEvents`

When you [configure a sink](install.md#configuring-cloudevents-notifications), Tekton emits
When you [configure a sink](https://tekton.dev/docs/installation/additional-configs/#configuring-cloudevents-notifications), Tekton emits
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When you [configure a sink](https://tekton.dev/docs/installation/additional-configs/#configuring-cloudevents-notifications), Tekton emits
When you [configure a sink](./additional-configs.md#configuring-cloudevents-notifications), Tekton emits

I think this should work for links at head as well as when they are imported to tekton.dev

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good. I've added the links. Thanks!

@jsminem jsminem requested a review from wlynch April 11, 2023 15:56
@afrittoli
Copy link
Member

/ok-to-test

@jsminem
Fixed Broken Links in Events Documentation
1e4c374 
Resolves issue Broken links in Cloud Event docs tektoncd#6423
Replaces broken link for CloudEvents Spec

Fixes: tektoncd#6423
@afrittoli
Copy link
Member

/ok-to-test

wlynch
wlynch approved these changes Apr 11, 2023
View reviewed changes
Copy link
Member

@wlynch wlynch left a comment

Choose a reason for hiding this comment

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

/lgtm

Thanks!

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 11, 2023
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wlynch

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 Apr 11, 2023
@tekton-robot tekton-robot merged commit cb99768 into tektoncd:main Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wlynch wlynch wlynch approved these changes

@vdemeester vdemeester Awaiting requested review from vdemeester

Assignees

@wlynch wlynch

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Broken links in Cloud Event docs
4 participants
@jsminem @tekton-robot @afrittoli @wlynch