Skip to content

Add sync config for Tekton Pruner documentation#696

Open
infernus01 wants to merge 2 commits intotektoncd:mainfrom
infernus01:pruner-sync-config
Open

Add sync config for Tekton Pruner documentation#696
infernus01 wants to merge 2 commits intotektoncd:mainfrom
infernus01:pruner-sync-config

Conversation

@infernus01
Copy link
Member

Changes

This PR adds sync/config/pruner.yaml to sync documentation from tektoncd/pruner to the website.

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.

@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 5, 2026
@infernus01
Copy link
Member Author

/hold

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 5, 2026
@infernus01
Copy link
Member Author

/unhold

@tekton-robot tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 5, 2026
@infernus01 infernus01 force-pushed the pruner-sync-config branch 2 times, most recently from 83251ea to 319acd3 Compare February 5, 2026 12:23
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 5, 2026
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 5, 2026
@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 5, 2026
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

Can you squash your commits ? Also, do we need the image in this PR ?

@tekton-robot
Copy link

[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

Details 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 Feb 6, 2026
@AlanGreene
Copy link
Member

do we need the image in this PR ?

Generally images should be loaded from the project repo, i.e. tektoncd/pruner, rather than adding them directly in the website repo.
If you take a look at the config for some of the other projects you'll see they copy images from the source repo alongside the markdown files.

@infernus01
Copy link
Member Author

infernus01 commented Feb 9, 2026

image

@vdemeester @AlanGreene I tried that approach, it seems Hugo doesn't serve files from content/ at URL paths.
We could do one thing, we need to do changes in Pruner repo, if we could reference the image from the root directory of Pruner itself (such as Chains did here.

@infernus01 infernus01 force-pushed the pruner-sync-config branch 2 times, most recently from c6f50d9 to 5ceea23 Compare February 9, 2026 11:13
Signed-off-by: Shubham Bhardwaj <shubbhar@redhat.com>
Signed-off-by: Shubham Bhardwaj <shubbhar@redhat.com>
- README.md
- ARCHITECTURE.md
docs:
include: ['*.md']
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
include: ['*.md']
include: ['*.md', '*.png']

If you include images here they'll be copied correctly, including from any sub-directories.

It's then a matter of updating the doc in the pruner repo to reference it correctly.

One option that may help simplify this is to move your README.md from the root of the repo into the docs folder. GitHub will still display it on the repo landing page, so there will be no impact on users viewing the repo directly. This is the approach taken by both Dashboard and Results.

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

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments