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

Rewrite the EventListeners Page #1060

Merged
merged 1 commit into from
Apr 21, 2021
Merged

Rewrite the EventListeners Page #1060

merged 1 commit into from
Apr 21, 2021

Conversation

tualeron
Copy link
Contributor

Changes

Rewrites the EventListener page for clarity and flow, breaks out rewritten Interceptor documentation into the already published interceptors.md page, and merges rewritten content from the exposing-eventlisteners.md page.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

NONE

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Apr 16, 2021
@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Apr 16, 2021
@tualeron
Copy link
Contributor Author

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Apr 16, 2021
@tualeron
Copy link
Contributor Author

/assign @dibyom

dibyom
dibyom reviewed Apr 20, 2021
View reviewed changes
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated
- VolumeMounts
- Env
```
## Specifying target namespaces
Copy link
Member

Choose a reason for hiding this comment

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

Do you think its clearer if we say something like Specifying Triggers in target namespaces? (And for the label selector below, - Specifying Triggers using labels?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed both to "Constraining EventListeners to specific namespaces/labels" let me know if that works.

docs/eventlisteners.md Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
docs/eventlisteners.md Outdated Show resolved Hide resolved
@tualeron
Copy link
Contributor Author

Addressed all review comments, PTAL!

@dibyom
Copy link
Member

dibyom commented Apr 21, 2021

Should we remove the exposing-eventlisteners.md page?

@tualeron
Copy link
Contributor Author

Should we remove the exposing-eventlisteners.md page?

Yes, let's delete it in a new PR after we publish this rewrite.

@jmcshane
Copy link
Contributor

It is still referenced in the content you are merging in this PR, so we'd have to ensure the content was appropriately merged into the new page. I agree tho, new PR for handing that page.

@tualeron
Copy link
Contributor Author

It is still referenced in the content you are merging in this PR, so we'd have to ensure the content was appropriately merged into the new page. I agree tho, new PR for handing that page.

The old exposing-eventlisteners.md page is not linked or mentioned anywhere in the rewritten content.

@jmcshane
Copy link
Contributor

@sergetron ah, shoot..i saw the link to #exposing-eventlisteners and thought it was an external link

@tualeron
Copy link
Contributor Author

@sergetron ah, shoot..i saw the link to #exposing-eventlisteners and thought it was an external link

Still a good catch - that link was broken, just fixed it. :)

@tualeron
Rewrite the EventListeners Page
08afb6b 
Rewrites the `EventListener` page for clarity and flow, breaks out rewritten `Interceptor` documentation into the already published `interceptors.md` page, and merges rewritten content from the `exposing-eventlisteners.md` page.
@tualeron
Copy link
Contributor Author

All comments addressed and broken links fixed. PTAL.

@jmcshane
Copy link
Contributor

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 21, 2021
@tualeron
Copy link
Contributor Author

If all looks good can we get approval @dibyom?

@dibyom
Copy link
Member

dibyom commented Apr 21, 2021

/approve

@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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

@dibyom dibyom dibyom left review comments

@khrm khrm Awaiting requested review from khrm

@wlynch wlynch Awaiting requested review from wlynch

Assignees

@dibyom dibyom

@jmcshane jmcshane

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. release-note-none Denotes a PR that doesnt merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@tualeron @dibyom @jmcshane @tekton-robot