Skip to content

Improve Webhooks Documentation for Argo Workflows #14243

New issue

Have a question about this project? No Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

No Sign up for GitHub

By clicking “No 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? No Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve Webhooks Documentation for Argo Workflows #14243

wants to merge 2 commits into from

Conversation

ssganesh035
Copy link

  1. Enhanced clarity and structure for webhook configuration.
  2. Added detailed steps for setting up roles, service accounts, and secrets.
  3. Included a table for better readability of webhook parameters.
  4. Ensured Markdown formatting aligns with GitHub documentation standards.

@ssganesh035
Update webhooks.md
aacfad2 
Signed-off-by: Sudar Selva Ganesh M <117903686+ssganesh035@users.noreply.github.com>
tico24
tico24 suggested changes Mar 6, 2025
View reviewed changes
Copy link
Member

@tico24 tico24 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for this. As well as my comments, the PR title also needs updating and you need to run make docs locally.

Ensured Markdown formatting aligns with GitHub documentation standards.

We use the k8s standards

@ssganesh035
Updated the suggested changes
14b4f13 
Signed-off-by: Sudar Selva Ganesh M <117903686+ssganesh035@users.noreply.github.com>
tico24
tico24 reviewed Mar 14, 2025
View reviewed changes
docs/webhooks.md

In the namespace that will receive the event, create [access token](access-token.md) resources for your client:
To enable webhook-based event triggering, you need to configure authentication and authorization within the namespace that will receive the event. This involves setting up roles, service accounts, and secrets.
Copy link
Member

Choose a reason for hiding this comment

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

each sentence on its own line please. See docs contribution guide.

@tico24
Copy link
Member

tico24 commented Mar 14, 2025

Thanks for this. As well as my comments, the PR title also needs updating and you need to run make docs locally.

This hasn't been done yet fyi.

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

@tico24 tico24 tico24 requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ssganesh035 @tico24