fix links to files on installation files page (#4998) #5751

prushh · 2023-11-08T13:28:42Z

Use artifact macro to generate the link to the appropriate yaml files for the serving and eventing installation pages.

Use artifact macro to generate the link to the appropriate files.

netlify · 2023-11-08T13:28:49Z

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`16cc872`
🔍 Latest deploy log	https://app.netlify.com/sites/knative/deploys/654b8d0d0b0c310008775740
😎 Deploy Preview	https://deploy-preview-5751--knative.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

knative-prow · 2023-11-08T13:28:52Z

Welcome @prushh! It looks like this is your first PR to knative/docs 🎉

ReToCode

Thanks @prushh looks good. Let's see what the eventing folks have to say about the eventing-sugar-controller.

/hold

ReToCode · 2023-11-08T14:21:18Z

docs/install/yaml-install/eventing/eventing-installation-files.md

+| [eventing-core.yaml]({{ artifact(repo="eventing",file="eventing-core.yaml")}}) | Required: Knative Eventing core components. |  [eventing-crds.yaml]({{ artifact(repo="eventing",file="eventing-crds.yaml")}}) |
+| [eventing-crds.yaml]({{ artifact(repo="eventing",file="eventing-crds.yaml")}}) | Required: Knative Eventing core CRDs. |  none |
+| [eventing-post-install.yaml]({{ artifact(repo="eventing",file="eventing-post-install.yaml")}}) | Jobs required for upgrading to a new minor version. | [eventing-core.yaml]({{ artifact(repo="eventing",file="eventing-core.yaml")}}), [eventing-crds.yaml]({{ artifact(repo="eventing",file="eventing-crds.yaml")}}) |
+| [eventing-sugar-controller.yaml]({{ artifact(repo="eventing",file="eventing-sugar-controller.yaml")}}) | Reconciler that watches for labels and annotations on certain resources to inject eventing components. | [eventing-core.yaml]({{ artifact(repo="eventing",file="eventing-core.yaml")}}) |


@pierDipi @creydr is this still used? The link seems to end up in 404.

IIRC the sugar controller can be enabled now via a config map and no additional deployment is required. Anyhow I leave it to @pierDipi for the final confirmation, that this line can be removed

https://deploy-preview-5751--knative.netlify.app/docs/eventing/configuration/sugar-configuration/

If so, we should update at least two files in addition to the one above:

docs/docs/install/uninstall.md -> L148-L154

docs/docs/install/yaml-install/eventing/install-eventing-with-yaml.md -> L231-L254

Do you think there are others?

@pierDipi Should I create a new PR with the changes mentioned above?

psschwei · 2023-11-08T21:40:55Z

Thanks for the PR!

It might not be a bad idea to run the full build (with versions) locally just to double check the links are correct in the release branches, since the preview only builds from main and thus gets the yamls from googlestorage rather than the release branch(es)...

prushh · 2023-11-08T22:19:12Z

It might not be a bad idea to run the full build (with versions) locally just to double check the links are correct in the release branches, since the preview only builds from main and thus gets the yamls from googlestorage rather than the release branch(es)...

Sure!
I will run the full build tomorrow and check that the links on the different release branches are correct.

psschwei · 2023-11-09T03:01:27Z

Actually, turns out you can't just build the release branches to test (since the release branches are pulled from github which don't have this change). But, running something like this:

KNATIVE_VERSION="v1.12.0" BUILD_VERSIONS=no ./hack/build.sh serve

will do the build in a way that you can check

http://127.0.0.1:8080/docs/install/yaml-install/serving/serving-installation-files/
http://127.0.0.1:8080/docs/install/yaml-install/eventing/eventing-installation-files/

and see that the changes should be picked up in the release branches, though you'll need to cherry pick this change for it to show up on the site (at least into the the branch of the most current release)

prushh · 2023-11-09T11:18:29Z

Looks good for both pages, the links point to the release specified by the KNATIVE_VERSION env:

If I understand well, should we also specify (at least) the first command from the following list?

/cherrypick release-1.12
/cherrypick release-1.11
/cherrypick release-1.10

psschwei · 2023-11-09T12:35:38Z

should we also specify (at least) the first command from the following list?

Yes, that's right

prushh · 2023-11-09T12:58:54Z

/cherrypick release-1.12

I leave you the other two commands if you think to update old releases!

knative-prow-robot · 2023-11-09T12:59:02Z

@prushh: only knative org members may request cherry-picks. You can still do the cherry-pick manually.

In response to this:

/cherrypick release-1.12

I leave you the other two commands if you think to update old releases!

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.

psschwei · 2023-11-09T13:13:19Z

/cherrypick release-1.12

knative-prow-robot · 2023-11-09T13:13:21Z

@psschwei: once the present PR merges, I will cherry-pick it on top of release-1.12 in a new PR and assign it to you.

In response to this:

/cherrypick release-1.12

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.

prushh · 2023-11-09T14:09:12Z

Sorry, I didn't know it was a limited-use command.

Thanks @psschwei!

pierDipi

/lgtm
/approve

knative-prow · 2023-12-05T09:33:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pierDipi, prushh

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:

~~OWNERS~~ [pierDipi]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pierDipi · 2023-12-05T09:33:26Z

/unhold

knative-prow-robot · 2023-12-05T09:36:14Z

@psschwei: new pull request created: #5786

In response to this:

/cherrypick release-1.12

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.

fix links to files on installation files page

16cc872

Use artifact macro to generate the link to the appropriate files.

knative-prow bot requested review from pierDipi and skonto November 8, 2023 13:28

knative-prow bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 8, 2023

ReToCode reviewed Nov 8, 2023

View reviewed changes

knative-prow bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 8, 2023

pierDipi approved these changes Dec 5, 2023

View reviewed changes

knative-prow bot assigned pierDipi Dec 5, 2023

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Dec 5, 2023

knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 5, 2023

knative-prow bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 5, 2023

knative-prow bot merged commit df08d10 into knative:main Dec 5, 2023
17 checks passed

knative-prow-robot mentioned this pull request Dec 5, 2023

[release-1.12] fix links to files on installation files page (#4998) #5786

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix links to files on installation files page (#4998) #5751

fix links to files on installation files page (#4998) #5751

prushh commented Nov 8, 2023

netlify bot commented Nov 8, 2023 •

edited

Loading

knative-prow bot commented Nov 8, 2023

ReToCode left a comment

ReToCode Nov 8, 2023

creydr Nov 8, 2023

creydr Nov 8, 2023

prushh Nov 8, 2023

prushh Dec 5, 2023

psschwei commented Nov 8, 2023

prushh commented Nov 8, 2023 •

edited

Loading

psschwei commented Nov 9, 2023

prushh commented Nov 9, 2023

psschwei commented Nov 9, 2023

prushh commented Nov 9, 2023

knative-prow-robot commented Nov 9, 2023

psschwei commented Nov 9, 2023

knative-prow-robot commented Nov 9, 2023

prushh commented Nov 9, 2023

pierDipi left a comment

knative-prow bot commented Dec 5, 2023

pierDipi commented Dec 5, 2023

knative-prow-robot commented Dec 5, 2023

fix links to files on installation files page (#4998) #5751

fix links to files on installation files page (#4998) #5751

Conversation

prushh commented Nov 8, 2023

netlify bot commented Nov 8, 2023 • edited Loading

✅ Deploy Preview for knative ready!

knative-prow bot commented Nov 8, 2023

ReToCode left a comment

Choose a reason for hiding this comment

ReToCode Nov 8, 2023

Choose a reason for hiding this comment

creydr Nov 8, 2023

Choose a reason for hiding this comment

creydr Nov 8, 2023

Choose a reason for hiding this comment

prushh Nov 8, 2023

Choose a reason for hiding this comment

prushh Dec 5, 2023

Choose a reason for hiding this comment

psschwei commented Nov 8, 2023

prushh commented Nov 8, 2023 • edited Loading

psschwei commented Nov 9, 2023

prushh commented Nov 9, 2023

psschwei commented Nov 9, 2023

prushh commented Nov 9, 2023

knative-prow-robot commented Nov 9, 2023

psschwei commented Nov 9, 2023

knative-prow-robot commented Nov 9, 2023

prushh commented Nov 9, 2023

pierDipi left a comment

Choose a reason for hiding this comment

knative-prow bot commented Dec 5, 2023

pierDipi commented Dec 5, 2023

knative-prow-robot commented Dec 5, 2023

netlify bot commented Nov 8, 2023 •

edited

Loading

prushh commented Nov 8, 2023 •

edited

Loading