Restructure "Eventing component" section

knative / docs

User documentation for Knative components.

https://knative.dev/docs/

Other

4.54k stars 1.23k forks source link

Restructure "Eventing component" section #1923

Closed RichieEscarez closed 3 years ago

RichieEscarez commented 5 years ago

Align content with the developer flow and arrange content into logical sections.

View proposed nav structure

For all moved or renamed files, add a redirect to that file's frontmatter (#1925)
[x] Create a Eventing only install section
[ ] Create new “Event consumers” section
[ ] Create new “Event producers” section
[x] Create new “Debugging” section
[x] Organize “Debugging (and Observabiltiy)” content into new section

abrennan89 commented 4 years ago

I think the eventing only install section is covered now in the docs here https://knative.dev/docs/install/any-kubernetes-cluster/ ? @carieshmarie wdyt? Can we check off that item in the list?

knative-housekeeping-robot commented 4 years ago

Issues go stale after 90 days of inactivity. Mark the issue as fresh by adding the comment /remove-lifecycle stale. Stale issues rot after an additional 30 days of inactivity and eventually close. If this issue is safe to close now please do so by adding the comment /close.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/lifecycle stale

RichieEscarez commented 4 years ago

Reopening for now but we need revisit this

abrennan89 commented 4 years ago

I think creating issues like this that are one big long list actually end up getting ignored a lot of the time because it's too much scope / too much like an epic rather than a single issue to track a docs change. Maybe try splitting the list up?

abrennan89 commented 3 years ago

Note to self: Conceptual info re producers / consumers in this PR can be added: https://github.com/knative/docs/pull/3476

abrennan89 commented 3 years ago

Note to self: Related to https://github.com/knative/ux/issues/39

abrennan89 commented 3 years ago

For observability and debugging, these require engineering input/work that are already tracked as other issues:

https://github.com/knative/docs/issues/3044 debugging
https://github.com/knative/docs/issues/2931 observability Checking these off the list for this issue

abrennan89 commented 3 years ago

Once you split out the tasks from this issue (I removed some of the original list items and made them their own issues), what's left is a pretty generic request for information. I think just adding info about "event producers and consumers" out of context doesn't really add any value, so I'd like for us to close this one for now and revisit this when we have bandwidth to flesh out some more conceptual topics about Knative as a whole. Probably makes more sense to do this after we've split docs into different "guides" for different personas as well, so that we know what type of info is required.