knative
Make install downloads findable
Overview
Currently the binary install download links in the Installing section redirect to the release notes, where the list of download files is far down the page. Move and relabel the download file sectionm so that the files are easy to find.
Audience: All
Type: Instructional
Context
This issue tracks recommended changes resulting from an analysis of the Knative
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0015-knative.
Possible Implementation
Related material in the current doc:
- https://knative.dev/docs/install/quickstart-install/#__tabbed_1_2
- https://knative.dev/docs/client/install-kn/#__tabbed_1_2
- https://knative.dev/docs/install/operator/knative-with-operator-cli/#__tabbed_1_1
- https://knative.dev/docs/install/operator/knative-with-operator-cli/#__tabbed_1_2
- https://github.com/knative/client/releases
Suggested changes:
Move the install download links to the top of the Release Notes or clearly link to them from the top of the Release Notes. Or, put them on their own Downloads page.
Rename the heading for the download files from "Assets" to "Downloads" or "Install files
This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hey @dwelsch-esi What do you think about this issue. I think it is general practice. However if it were to be resolved would you prefer updates in documentation/ a separate downloads page, let me know & I will get it done!
We don't have control over the GitHub "Releases" view that we're linking for downloads. Our release notes are also very long because they include all the dependency updates.
At the same time, I'm reticent to put links to artifacts directly in the release notes, because of the opportunity to link to someplace other than the official GitHub content. e.g.
v1.20.0 Latest
Dependencies
Added
- github.com/prometheus/otlptranslator: v1.0.0
- golang.org/x/tools/go/expect: v0.1.1-deprecated
- golang.org/x/tools/go/packages/packagestest: v0.1.1-deprecated
- gonum.org/v1/gonum: v0.16.0
If we were going to fix this, we should link directly to the github-hosted binaries, rather than to the releases page (and we'd need a mechanism for selecting OS/arch and a fallback). If we want to do this, we could use a macro like the artifact macro defined here: https://github.com/knative/docs/blob/main/hack/macros.py#L104
