Add Verifier developer guide to presto doc #12686
Add Verifier developer guide to presto doc #12686caithagoras wants to merge 1 commit intoprestodb:masterfrom
Conversation
mayankgarg1990
left a comment
There was a problem hiding this comment.
It will be great if @rschlussel can also take a look since her English grammar knowledge is much better than mine :)
b4d370e to
bccd7cc
Compare
rschlussel
left a comment
There was a problem hiding this comment.
This documentation lists all kinds of configurations that can be set and plugins that can be added but the user documentation doesn't have explanations for how to do most of these things. I think you should expand the user documentation to include descriptions of how to do all the things described here and also to include more fleshed out overview of what the verifier does and how it works so people can understand what they are configuring.
I don't know what our guidelines are for user vs. developer documentation, but nearly everything in this PR seems suitable for user documentation. I'm not sure we'll need developer documentation if the user documentation is more thorough.
There was a problem hiding this comment.
e.g. not i.e.. But I would elaborate that by default Global and time limit exceeded are the only failures that are automatically resolved.
Also, I'm curious whether you can turn off automatic resolution of those failures (e.g. if you have the same cluster set up for both, I imagine people may not want those automatically resolved).
There was a problem hiding this comment.
We don't have the switch yet but it make sense to me to add one.
|
@rschlussel I wonder what you are referring to when use said "user documentation"? I though the developer guide is part of the user documentation but is more towards power users. Currently we have a section about verifier in the |
|
@caithagoras I didn't realize at first that it was in a section of the user documentation. But either way my point is that all the documentation should be together in one place. Right now there's "beginner" information in one place that isn't quite enough to understand what the verifier is or how to use it. and then there's "advanced" information in another place that explains more background about how it works and things you can do, but doesn't tell you how to do them or where you could learn more. I think it would be much clearer for both kinds of users to have all the information in one place. I don't think it matters whether it goes in the installation section or the developer section. |
|
@caithagoras This documentation would be very useful for folks who are running the verifiers and investigating the results. It is helpful to understand what kind of things are resolved automatically and what are not. Let's address the comments and land this doc. CC: @nezihyigitbasi |
No description provided.