Update README.md with vision statement #89
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a vision statement for implementers to understand the underlying logic.
|
|
||
| * Keep things as imutable as possible | ||
| * A trace can be queried for any UI elements. | ||
| * UI elements can be but should not be limited to charts, graphs, trees and more. |
There was a problem hiding this comment.
Markdownlint has issues with this reformatted line and the few ones below (8 and 9).
| @@ -1,5 +1,17 @@ | |||
| # trace-server-protocol | |||
|
|
|||
| The Trace Server Protocol is a protocol designed to allow frontend visualizers to be decoupled from backend. It allows the frontend to query resources in a RESTful way. The guiding principles: | |||
|
|
|||
| * Keep things as imutable as possible | |||
| The Trace Server Protocol is a protocol designed to allow frontend visualizers to be decoupled from backend. It allows the frontend to query resources in a RESTful way. The guiding principles: | ||
|
|
||
| * Keep things as imutable as possible | ||
| * A trace can be queried for any UI elements. |
| @@ -1,5 +1,17 @@ | |||
| # trace-server-protocol | |||
|
|
|||
| The Trace Server Protocol is a protocol designed to allow frontend visualizers to be decoupled from backend. It allows the frontend to query resources in a RESTful way. The guiding principles: | |||
|
|
|||
| * Keep things as imutable as possible | |||
| * Filtering on the server side may produce additional UI elements. | ||
| * The data type is delivered to the client so the client can remain as lightweight as possible. | ||
|
|
||
| The initial design is base on the Eclipse Trace Compass backend and the theia-trace-extension frontend, however this protocol is agnostic and all changes will be considered and suggestions are welcomed. |
| ** The data type is delivered to the client so the client can remain as lightweight as possible. | ||
| * UI elements can be but should not be limited to charts, graphs, trees and more. | ||
| * Filtering on the server side may produce additional UI elements. | ||
| * The data type is delivered to the client so the client can remain as lightweight as possible. |
There was a problem hiding this comment.
The second commit should be squashed into the first/base one, here in this specific case.
| @@ -1,5 +1,17 @@ | |||
| # trace-server-protocol | |||
|
|
|||
| The Trace Server Protocol is a protocol designed to allow frontend visualizers to be decoupled from backend. It allows the frontend to query resources in a RESTful way. The guiding principles: | |||
There was a problem hiding this comment.
Not sure about the RESTful way,
- as TSP currently bundles a lot of request payload into the body.
- Recent cross-team discussions also highlighted the current limitations in terms of resource/entity modeling, starting at the request URI level.
- We also mentioned the domain language which could improve from an ubiquity perspective.
- All in all, this README may mention the REST/http basis of TSP, without claiming REST-fullness, I think.
| @@ -1,5 +1,17 @@ | |||
| # trace-server-protocol | |||
There was a problem hiding this comment.
Commit message(s) and PR header are missing a Signed-off-by footer.
There was a problem hiding this comment.
Addendum: commit message's body line needs a wrap to max 72 chars, per guideline.
marco-miller
requested changes
Mar 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a vision statement for implementers to understand the underlying logic.