Skip to content

Add sync config for Tekton Pruner documentation#696

Merged
tekton-robot merged 2 commits intotektoncd:mainfrom
infernus01:pruner-sync-config
Feb 24, 2026
Merged

Add sync config for Tekton Pruner documentation#696
tekton-robot merged 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 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
@vdemeester
Copy link
Member

@AlanGreene are we good to go now ? 👼🏼

@AlanGreene
Copy link
Member

I don't think so. Looking at the preview: https://deploy-preview-696--tekton.netlify.app/docs/pruner/

image

The image isn't loading.

@infernus01
Copy link
Member Author

infernus01 commented Feb 23, 2026

That's strange, I have tested in my local, and it's fetching the image properly. Pruner repo now has that image at the root.
image

@infernus01
Copy link
Member Author

Even the /content/en/docs/Pruner contains that image:
image

@AlanGreene
Copy link
Member

The page URL is: https://deploy-preview-696--tekton.netlify.app/docs/pruner/
The image URL is: docs/images/pruner_functional_abstract.png

Since it's a relative URL, it's attempting to load the image from https://deploy-preview-696--tekton.netlify.app/docs/pruner/docs/images/pruner_functional_abstract.png which is incorrect.

You will need to change the URL used to load the image to /docs/… or another appropriate value to ensure it works for both the website and when viewing directly on the repo itself.

That's why I suggested moving the repo into the docs folder in the repo: #696 (comment)

See for example the Dashboard readme referencing an image in the docs folder: https://github.com/tektoncd/dashboard/blob/6e54039d61e7b6de46efb56e61d3039b8091acb5/docs/README.md?plain=1#L22

@infernus01
Copy link
Member Author

/test

@infernus01
Copy link
Member Author

That's why I suggested moving the repo into the docs folder in the repo: #696 (comment)

image

@AlanGreene I respect that suggestion, it is not that I didn't want to do that. But the problem was that I pushed the earlier changes before the pruner repo was modified with that image.and hence the build was not updated later, I just did a dummy push to retrigger that build and it is working fine.
Please let me know if you still suggest to move readme to docs folder.

Signed-off-by: Shubham Bhardwaj <shubbhar@redhat.com>
Signed-off-by: Shubham Bhardwaj <shubbhar@redhat.com>
Copy link
Member

@AlanGreene AlanGreene left a comment

Choose a reason for hiding this comment

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

Confirmed the image is loading as expected both in the website preview and in the pruner repo directly. Looks good 👍
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 24, 2026
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AlanGreene, 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:
  • OWNERS [AlanGreene,vdemeester]

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 merged commit 1aea175 into tektoncd:main Feb 24, 2026
8 checks passed
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. lgtm Indicates that a PR is ready to be merged. 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