-
Notifications
You must be signed in to change notification settings - Fork 16
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
doc: Fix Eventing State doc formatting #502
doc: Fix Eventing State doc formatting #502
Conversation
docs/user/02-configuration.md
Outdated
- The <b>Backend Config</b> column is part of the eventing CR that is either available or mistakenly not specified by a user. | ||
- The <b>Backend State</b> column describes the state of the NATS backend or EventMesh Secret existence. | ||
- The <b>Backend State</b> column describes the state of the NATS backend or EventMesh Secret existence. | ||
- The <b>Eventing State</b> column has the overall state of the Eventing CR. | ||
|
||
Warnings indicate that user action is required, that is, the user must install the NATS module or create an EventMesh Secret. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In line 89, "Impact on Event Flow" must be in title case because it's a heading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, how about the following order of rows and columns:
| Backend Type | Backend Config | Backend State | Eventing State | Impact on Event Flow | | |
|----------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------| | |
| NATS/EventMesh | missing | n/a | Warning | No events will be accepted or dispatched | | |
| NATS/EventMesh | exists | Processing (mainly happens during initialization and backend switching) | Processing | No events will be accepted or dispatched | | |
| NATS | exists | Warning (NATS deletion blocked) | Ready | Events will be accepted or dispatched | | |
| NATS | exists | Error (NATS ist unavailable or cannot be connected) | Warning | No events will be accepted or dispatched | | |
| NATS | exists | Missing | Warning | No events will be accepted or dispatched | | |
| EventMesh | exists | Error (secret for EventMesh missing) | Warning | No events will be accepted or dispatched | | |
| NATS/EventMesh | exists | Error (cases not caused by a user, such as cannot create EPP deployment or cannot start subscription manager although backend is available) | Error | No events will be accepted or dispatched | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We discussed the order with Korbinian and we agreed to this order. Why do you want to change it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because I think a) backend missing or existing is the first important distinction; with a missing backend, all later steps are irrelevant. That's why I pulled that row up. I also added "n/a" to that field, so that there's no misunderstanding whether we simply forgot to enter information there.
Furthermore, because as a user, I think it's easiest to know whether I have NATS or EventMesh, so I pulled that column to the first position.
This also matches the fact that this is about the impact of the backend to the Eventing CR State and Event Flow; so the focus is on the backend. Conversely, if the purpose of the table had been "Understanding the causes of the Eventing state"; I'd pull the "Eventing State" column to the first position.
In general, I personally find option A easier to understand than option B:
255dd0c
to
c787271
Compare
Description
Fix eventing state doc formatting
Related issue(s)
#328