Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure "Eventing component" section #1923

Closed
3 of 5 tasks
RichieEscarez opened this issue Oct 23, 2019 · 8 comments · Fixed by #3869
Closed
3 of 5 tasks

Restructure "Eventing component" section #1923

RichieEscarez opened this issue Oct 23, 2019 · 8 comments · Fixed by #3869
Assignees
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/eventing priority/high

Comments

@RichieEscarez
Copy link
Contributor

RichieEscarez commented Oct 23, 2019

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 (Ensure that all content affected by the nav changes gets a "redirect" #1925)
  • Create a Eventing only install section
  • Create new “Event consumers” section
  • Create new “Event producers” section
  • Create new “Debugging” section
  • Organize “Debugging (and Observabiltiy)” content into new section
@abrennan89
Copy link
Contributor

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

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

@knative-prow-robot knative-prow-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 26, 2020
Navigation changes - Info architecture automation moved this from To do to Done Jul 26, 2020
@RichieEscarez RichieEscarez removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 20, 2020
@RichieEscarez
Copy link
Contributor Author

Reopening for now but we need revisit this

@RichieEscarez RichieEscarez reopened this Aug 20, 2020
Navigation changes - Info architecture automation moved this from Done to In progress Aug 20, 2020
@abrennan89
Copy link
Contributor

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 abrennan89 self-assigned this Oct 20, 2020
@abrennan89 abrennan89 modified the milestones: Backlog, Icebox Jan 6, 2021
@abrennan89 abrennan89 moved this from In progress to To do in Navigation changes - Info architecture Jan 6, 2021
@abrennan89 abrennan89 removed their assignment Jan 6, 2021
@abrennan89 abrennan89 added diagram kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Jan 6, 2021
@abrennan89 abrennan89 modified the milestones: Icebox, Backlog Jan 26, 2021
@abrennan89 abrennan89 added the Epic Epics to group issues label Apr 22, 2021
@abrennan89 abrennan89 removed this from To do in [EPIC] Clean up cruft Apr 22, 2021
@abrennan89
Copy link
Contributor

Note to self: Conceptual info re producers / consumers in this PR can be added: #3476

@abrennan89 abrennan89 self-assigned this Apr 28, 2021
@abrennan89 abrennan89 modified the milestones: Backlog, v0.24.0 May 3, 2021
@abrennan89
Copy link
Contributor

Note to self: Related to knative/ux#39

@abrennan89
Copy link
Contributor

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

@abrennan89
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/eventing priority/high
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants