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

Add TektonResult to TektonConfig doc #2400

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

Add TektonResult to TektonConfig doc #2400

wants to merge 1 commit into from

Conversation

pratap0007
Copy link
Contributor

@pratap0007 pratap0007 commented Nov 11, 2024 •
edited
Loading

Changes

This will add the instructions in TektonConfig doc how to install and manage
Results component through Tekton Config TektonConfig doc and updates TektonResult doc

Submitter Checklist

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

See the contribution guide for more details.

Release Notes

Add instructions to install and manage  Tekton Results through Tekton Config

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Nov 11, 2024
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 11, 2024
@pratap0007 pratap0007 mentioned this pull request Nov 11, 2024
Merged
4 tasks
jkandasa
jkandasa reviewed Nov 19, 2024
View reviewed changes
docs/TektonConfig.md
result:
disabled: false
is_external_db: false
options: {}
Copy link
Member

Choose a reason for hiding this comment

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

@pratap0007 still the results is not part for TektonConfig CRD

jkandasa
jkandasa reviewed Nov 19, 2024
View reviewed changes
Copy link
Member

@jkandasa jkandasa 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 the PR @pratap0007,
however the results is not part of the TektonConfig CRD, if you are working on the implementation, please update this doc changes on the implementation PR.

@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign piyush-garg after the PR has been reviewed.
You can assign the PR to them by writing /assign @piyush-garg 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

@pratap0007 pratap0007 changed the title Update TektonResult docs Add TektonResult to TektonConfig doc Nov 25, 2024
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 16, 2024
khrm
khrm reviewed Jan 15, 2025
View reviewed changes
docs/TektonConfig.md
Result section allows user to customize the Tekton Result component, Refer to [Result Spec](https://github.com/tektoncd/operator/blob/main/docs/TektonResult.md#spec) section in TektonResult for available options.

Example:

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we mention what's the default when no values are specified?

Copy link
Member

Choose a reason for hiding this comment

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

@pratap0007 ^^^

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@khrm updated and please review once again

@pratap0007 pratap0007 force-pushed the update-result-docs branch 2 times, most recently from 7bb8836 to 2106dea Compare January 29, 2025 05:06
@pratap0007
Copy link
Contributor Author

/retest

@pratap0007
Copy link
Contributor Author

/restest

jkhelil
jkhelil reviewed Feb 4, 2025
View reviewed changes
docs/TektonConfig.md Outdated Show resolved Hide resolved
@pratap0007
Copy link
Contributor Author

/retest

@pratap0007
Add TektonResult to TektonConfig doc
6c9d8c7 
This will add the instructions in TektonConfig doc how to install and manage
Results component through Tekton Config TektonConfig doc and updates TektonResult doc

Signed-off-by: Shiv Verma
@rupalibehera
Copy link
Member

is it good to be merged ?

@pratap0007
Copy link
Contributor Author

is it good to be merged ?

yes, it is good to merge cc: @khrm @savitaashture

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

@jkandasa jkandasa jkandasa left review comments

@jkhelil jkhelil jkhelil left review comments

@piyush-garg piyush-garg Awaiting requested review from piyush-garg

@PuneetPunamiya PuneetPunamiya Awaiting requested review from PuneetPunamiya

Assignees
No one assigned
Labels
release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@pratap0007 @tekton-robot @rupalibehera @khrm @jkandasa @jkhelil