Admin overview config overviews #6482
Conversation
Added mermaid graphic and content formatting testing
❌ Deploy Preview for knative failed.Built without sensitive environment variables
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: iRaindrop The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
knative-prow
bot
added
the
size/M
knative-prow
bot
added
the
do-not-merge/work-in-progress
Formatting testing
Trying a "blog" approach....
Minor edits
Link fixes
Minor edits
| ```mermaid | ||
| --- | ||
| config: | ||
| theme: redux | ||
| --- | ||
| flowchart TD | ||
| A(["Administrator"]) --> B{"Knative"} | ||
| B --> C["Knative Serving"] & D["Knative Eventing"] |
There was a problem hiding this comment.
This doesn't exactly match what I was imagining for the "duck analogy" (which doesn't seem to show up in the text).
I was thinking of something more like:
| ```mermaid | |
| --- | |
| config: | |
| theme: redux | |
| --- | |
| flowchart TD | |
| A(["Administrator"]) --> B{"Knative"} | |
| B --> C["Knative Serving"] & D["Knative Eventing"] | |
| ```mermaid | |
| --- | |
| config: | |
| theme: redux | |
| --- | |
| flowchart TD | |
| Dev(["Application Developers"]) | |
| dev-acts@{ shape: text, label: "Manages k8s objects defined by" } | |
| subgraph Knative | |
| Serving | |
| Eventing | |
| end | |
| subgraph Plugins | |
| net-istio["Istio"] | |
| net-contour["Contour"] | |
| net-gateway-api["Gateway API"] | |
| event-kafka["Kafka"] | |
| event-rabbitmq["RabbitMQ"] | |
| event-nats["NATS"] | |
| end | |
| event-impl@{ shape: text, label: "implements" } | |
| net-impl@{ shape: text, label: "implements" } | |
| admin-acts@{ shape: text, label: "Installs and configures" } | |
| Admin(["Cluster Administrators"]) | |
| Dev --- dev-acts | |
| dev-acts --> Serving & Eventing | |
| admin-acts --- Admin | |
| Plugins & Knative --- admin-acts | |
| %% The ~~~ ... --> syntax is used to force backwards arrows; | |
| %% See https://github.com/mermaid-js/mermaid/issues/2629 for details. | |
| Serving ~~~ net-impl --> Serving | |
| Eventing ~~~ event-impl --> Eventing | |
| net-impl --- net-istio & net-contour & net-gateway-api | |
| event-impl --- event-kafka & event-rabbitmq & event-nats |
There was a problem hiding this comment.
For the links around event-impl and net-impl, you might want to use the -.- or -.-> syntax to make the lines dotted rather than solid
There was a problem hiding this comment.
Thanks - That was just a placeholder -- looks great
| Knative uses Kubernetes YAML manifests to define and configure system components. These manifests include core resources, custom resource definitions (CRDs), and extensibility features. As with Kubernetes, these configuration resources are declarative and can be managed using the `kubectl` CLI tool or with continuous delivery tools. | ||
|
|
||
| ### Resource scoping and namespaces | ||
| The following sections provide an overview of the current configurations procedures of interest to Administrators. |
There was a problem hiding this comment.
I'm still not entirely sold on duplicating the navigation in prose here. I realize that it's tempting to have a little more explanation than what's in the titles in the left-hand navigation, but I have a maintenance concern that duplicating the navigation here will cause the two to drift out of sync over time.
There was a problem hiding this comment.
Yeah, even thought it's at the node level. The Eventing config overviews fell nicely into a table, I can redo for Serving and Network Options into a table.
Co-authored-by: Evan Anderson <[email protected]>
knative-prow
bot
added
size/L
Added Eventing config summaries
Put all config overviews in tables
Section title tweaks
Formatting edits
Organized sections
Formatting test
Removed temporary test
2 participants
The overview of configuration tasks should parallell the Navigation.
Proposed Changes