search

knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.56k stars 1.23k forks source link

Add an "About Knative" page #4791

Open snneji opened 2 years ago

snneji commented 2 years ago

Task

  1. Add a README.md page to the "About" section that includes the following conceptual info:
    • high level info about Knative Serving + Eventing
    • architecture info
    • diagrams
  2. The page should be similar to Istio: https://istio.io/latest/about/service-mesh/
  3. The page should be the first page in the "About" section as it will be like an overview page.
  4. Page must have links to Serving, Eventing, Install
  5. Replace the link for the "Explore Knative" button on the homepage with a link to this page.

Questions to answer as follow up from https://github.com/knative/docs/issues/4668

  1. What is Knative?

Knative is a system that works on top of Kubernetes. It helps development teams manage, monitor, and operate Kubernetes in a way that requires less technical knowledge and time. Knative is open-source, finding support and growth through a combination of individual contributors and industry-leading companies.

  1. What's the difference between Knative Serving and Knative Eventing?

Knative has two main elements named Knative Serving and Knative Eventing. While they manage different tasks and outcomes and can operate independently, together, they help make Knative a powerful tool for dev teams and IT professionals. Knative Serving runs serverless containers on Kubernetes with ease. Knative takes care of the details of networking, autoscaling (even to zero), and revision tracking. You have to focus on your core logic. Knative Eventing allows for universal subscription, delivery, and management of events. Teams can build modern apps by attaching compute to a data stream with declarative event connectivity and a developer-friendly object model.

  1. Do I need to use Istio?
  2. What foundation is it under (CNCF, LF, etc)?
  3. Does Knative support serverless functions?
  4. Link to spin off section about users / adopters / case studies

Additional info

Spin off section about users / adopters / case studies (TODO: decide on name for this)

github-actions[bot] commented 2 years ago

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.

abrennan89 commented 2 years ago

As far as I'm concerned, this page could also cover all the requests proposed on https://github.com/knative/docs/issues/4668 and we can close that one?

abrennan89 commented 2 years ago

Removed FAQ from the list because I think these are sort of a nonsense thing and shouldn't be required if our info is laid out properly so that it's easy to find.

abrennan89 commented 2 years ago

I'd say case studies and testimonals should also be a separate page, not part of "About Knative" since they're not really explaining anything conceptual.