Docs: (Split of #1896) Add technical reference for install files for Knative Eventing

Created on 24 Feb 2021  路  12Comments  路  Source: knative/docs

Describe the change you'd like to see
This issues is a child issue to #1896. The only thing required for the "closing" of this issue is to create a markdown table of all of the Assets listed in the Eventing release.

In Scope:

  • list of installation files
  • table the describes the file and identifies dependencies/requirements

STORY

AS A New User

I WANT to understand what each of the Assets in a Knative Eventing Release is for 

SO THAT if I am preforming a custom install, I have reference documentation

Install files for Eventing can be found under "Assets" here: https://github.com/knative/eventing/releases/tag/v0.21.0

NOTE: unclear where this content goes as of yet, but don't let that stop you from making progress! It's just a 3 column .MD table after all :)

kineventing kingood-first-issue kinnew-docs-needed

All 12 comments

/assign

/assign @snneji

@omerbensaadon: GitHub didn't allow me to assign the following users: snneji.

Note that only knative members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @snneji

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.

@omerbensaadon there is typically a table in the release notes that could potentially be copied.

The eventing triage group looks over any issue that has the 'needs-eng-input' -- given that it seems you're already well on your way to solving this issue, can we drop the label at this time?

Thanks!

@lberk dropped!

And thanks for that tip about release notes...

@lberk sorry, where can I find that table in the release notes...? I looked https://github.com/knative/eventing/releases/tag/v0.21.0 and didn't see it

Thanks!

Its under the Assets label and has each file needed as well as the size.

@lberk ah yes, I was meaning something more like https://github.com/knative/docs/pull/3296

Is this something one of the folks on the Eventing WG could write up...?

That's sort of why I added the needs input label

@lberk I understood the ask as providing a description for the files that are under the Assets label as the file name themselves are not sufficient to help folks understand;

  • what each file contains (without looking at the contents)
  • which files are required/optional
  • if the files have dependencies

Please PR this to docs/install/assets/eventing.md!

Good timing, @snneji created https://github.com/knative/docs/pull/3304

Fantastic! This is coming along nicely.

Let's get some other reviewers on here :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ahmetb picture ahmetb  路  5Comments

d2iq-shadowbq picture d2iq-shadowbq  路  5Comments

dprotaso picture dprotaso  路  4Comments

hasheddan picture hasheddan  路  6Comments

yangyunfeng007 picture yangyunfeng007  路  4Comments