Skip to content

[EPIC] Additional content strategy work required to answer longstanding questions about Knative docs #5054

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

Closed
2 of 6 tasks
abrennan89 opened this issue Jun 28, 2022 · 1 comment
Assignees
Labels
Epic Epics to group issues

Comments

@abrennan89
Copy link
Contributor

abrennan89 commented Jun 28, 2022

Braindump of current requirements and priorities. We will add separate github issues as these become actionable, so that they can be assigned and worked on as part of the docs roadmap.

  • Create better conceptual information in the docs so that it's clear what different terms mean on a case by case basis, either similarly to Kubernetes documents concepts (https://kubernetes.io/docs/concepts/) or just by improving conceptual info throughout the docs. (Follows up on Create a glossary of terms with definitions #170)
  • We will open an additional issue to create a page named something like Adopters (? name needs more discussion probably) that provides info about who is using Knative, case studies, things like managed cloud offerings (since these are not a community thing but might be provided by partners / companies using Knative in products or on their platforms) (Follow up from Add "FAQ" to the knative.dev website #4668)
  • Istio vs Kourier vs other options, what is required, what isn't, and why users would use one over the other - this should be addressed adequately in the core docs so that it's not a question that's being asked all the time (Follow up from Add "FAQ" to the knative.dev website #4668)
  • Figure out what options are for landing pages / overviews with mkdocs
  • Follow this up with an audit for the current state of overview pages and create issues to batch update these and make the structure consistent across topics, depending on what structure we end up going with
  • Once we've decided about overview pages, decide the fate of Create an overview page for PingSource and for ContainerSource #4305
@knative-prow
Copy link

knative-prow bot commented Jun 28, 2022

@abrennan89: GitHub didn't allow me to assign the following users: user.

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:

Expected Behavior

Actual Behavior

Steps to Reproduce the Problem

Additional Info

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.

@abrennan89 abrennan89 added the Epic Epics to group issues label Jun 28, 2022
@abrennan89 abrennan89 self-assigned this Jul 29, 2022
@snneji snneji moved this to In design in Docs WG Roadmap Aug 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Epics to group issues
Projects
None yet
Development

No branches or pull requests

1 participant