[native] Add Prestissimo documentation page to Developer Guide #20564
Conversation
|
Codenotify: Notifying subscribers in CODENOTIFY files for diff 6f332a3...1dbf8e5.
|
pedroerp
force-pushed
the
prestissimo-docs
branch
from
8a72cbb
to
3575018
Compare
There was a problem hiding this comment.
Couple of minor but important nits, otherwise great document to build on. :) CC: @steveburnett for docs review
| =========================== | ||
|
|
||
| Prestissimo is a C++ drop-in replacement for Presto workers based on the Velox | ||
| library. It implements the same RESTful API as Java workers using the Proxygen |
There was a problem hiding this comment.
| library. It implements the same RESTful API as Java workers using the Proxygen | |
| library. It implements the same RESTful endpoints as Java workers using the Proxygen |
I would avoid using the word API because I would argue Presto doesn't have an API, it has an SPI.
| Prestissimo is a C++ drop-in replacement for Presto workers based on the Velox | ||
| library. It implements the same RESTful API as Java workers using the Proxygen | ||
| C++ HTTP framework. Since communication with the Java coordinator and across | ||
| workers in only done via the REST APIs, Prestissimo does not use JNI and it is |
There was a problem hiding this comment.
| workers in only done via the REST APIs, Prestissimo does not use JNI and it is | |
| workers in only done via the REST endpoints, Prestissimo does not use JNI and it is |
| Prestissimo is a C++ drop-in replacement for Presto workers based on the Velox | ||
| library. It implements the same RESTful API as Java workers using the Proxygen | ||
| C++ HTTP framework. Since communication with the Java coordinator and across | ||
| workers in only done via the REST APIs, Prestissimo does not use JNI and it is |
There was a problem hiding this comment.
Suggest "workers is only done", not "in".
Also, suggest not using Latin terms such as via. Consider alternatives such as with, through, or by using. (Reference: see "via" in Gitlab's documentation style guide.)
| Other HTTP endpoints include: | ||
|
|
||
| * POST: v1/memory | ||
| * This just reports memory, but no assignments are adjusted unlike in Java |
There was a problem hiding this comment.
| * This just reports memory, but no assignments are adjusted unlike in Java | |
| * This reports memory, but no assignments are adjusted unlike in Java |
| * **Default value:** ``0`` | ||
|
|
||
| The port that hosts the remote function server. If not specified and remote | ||
| functions are trying to be registered, throws. |
There was a problem hiding this comment.
It feels like something, maybe only a word or two, is missing after "throws".
| * **Type:** ``string`` | ||
| * **Default value:** ``""`` | ||
|
|
||
| The local filesystem path where json files containing remote function |
There was a problem hiding this comment.
"JSON file" is capitalized in the previous paragraph but not in this paragraph. Consider standardizing how "json file" is capitalized throughout the document for consistency.
|
Great work! I made a few minor comments about consistency and style, but the overall structure, organization, and content looks very good. |
pedroerp
force-pushed
the
prestissimo-docs
branch
from
3575018
to
e5d91a4
Compare
|
Thanks @tdcmeehan and @steveburnett for the quick review! Comments are addressed, please take another look when you have a moment. |
| * **Default value:** ``0`` | ||
|
|
||
| The port that hosts the remote function server. If not specified and remote | ||
| functions are trying to be registered, and exception is thrown. |
There was a problem hiding this comment.
| functions are trying to be registered, and exception is thrown. | |
| functions are trying to be registered, an exception is thrown. |
Adding a new documentation page for Prestissimo to the Developer Guide, and adding some of the configuration parameters for remote function execution.
pedroerp
force-pushed
the
prestissimo-docs
branch
from
e5d91a4
to
1dbf8e5
Compare
|
Fixed the last typo. Thank you guys! |
Adding a new documentation page for Prestissimo to the Developer Guide, and adding some of the configuration parameters for remote function execution.