pipeline icon indicating copy to clipboard operation
pipeline copied to clipboard

docs: fix links to Matrix examples

Open AverageMarcus opened this issue 1 year ago • 6 comments

Changes

Fixed the links on the Matrix docs page to point to the examples on GitHub instead of relative URLs.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • [x] Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • [ ] Has Tests included if any functionality added or changed
  • [ ] pre-commit Passed
  • [x] Follows the commit message standard
  • [x] Meets the Tekton contributor standards (including functionality, content, code)
  • [x] Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • [ ] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • [ ] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

/kind documentation

AverageMarcus avatar May 17 '24 08:05 AverageMarcus

Hi @AverageMarcus. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

tekton-robot avatar May 17 '24 08:05 tekton-robot

/kind documentation

AverageMarcus avatar May 17 '24 08:05 AverageMarcus

/ok-to-test

afrittoli avatar May 17 '24 09:05 afrittoli

Thanks for this PR @AverageMarcus - I think the problem with this approach is that the GitHub links are not versioned, so all the versioned published docs on https://tekton.dev/docs will point the variable version on main for those files. I think an alternative solution may be to change the sync/publishing scripts on the website to point those URLs to GitHub at publishing time, using a version specific link.

afrittoli avatar May 17 '24 09:05 afrittoli

Does that support pulling things from the examples directory though? Is there an existing place this is being done that I could copy?

AverageMarcus avatar May 17 '24 09:05 AverageMarcus

/approve /lgtm

chitrangpatel avatar Aug 22 '24 15:08 chitrangpatel

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel

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 avatar Aug 22 '24 15:08 tekton-robot