Add readme notes for worker apis#290
Merged
bergsieker merged 2 commits intomainfrom Mar 19, 2024
unknown repository
Merged
Conversation
EdSchouten
approved these changes
Mar 16, 2024
README.md
Outdated
Comment on lines
71
to
79
| Servers generally distribute work to a fleet of workers. While there is no | ||
| standard API for communication between the server and workers, links to the | ||
| APIs from some existing implementations are provided as a reference below. | ||
|
|
||
| The [Remote Worker API](https://docs.google.com/document/d/1s_AzRRD2mdyktKUj2HWBn99rMg_3tcPvdjx3MPbFidU) | ||
| defines a generic protocol for worker and server communication, although, | ||
| this API is considered too heavyweight for most use-cases. | ||
|
|
||
| *Adhering to any one of these protocols is not a requirement.* |
Collaborator
There was a problem hiding this comment.
Nit: I agree with all of the sentences under this heading, but I think that the order in which they are provided can be improved. What's your thought on the following?
Servers generally distribute work to a fleet of workers. The Remote Worker API defines a generic protocol for worker and server communication, although, this API is considered too heavyweight for most use-cases. Because of that, many implementations have designed their own protocols. Links to these APIs are provided as a reference below. Adhering to any one of these protocols is not a requirement.
- List of protocols goes here.
bergsieker
approved these changes
Mar 19, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Replaces #289
CLA should be happy now.