-
Notifications
You must be signed in to change notification settings - Fork 5.4k
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
[docs] Add Troubleshooting topic to documentation #24601
base: master
Are you sure you want to change the base?
[docs] Add Troubleshooting topic to documentation #24601
Conversation
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.
Thanks @steveburnett , this looks like a great idea to me. It's nice to have some common troubleshooting in official docs. I just had some minor suggestions.
1f3e4a9
to
5d6b08a
Compare
@yhwang and @kiersten-stokes - I've invited you as reviewers because I would like your advice on the content in the answer of the section "Error: VM option ‘UseG1GC’ is experimental" in the deploy.rst file. The answer I have was what I came up with, and it worked, but I hope you can either improve my answer or suggest a better and entirely different solution to this error. |
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.
LGTM, just want to make sure the last solution is clear
5d6b08a
to
6e95a2a
Compare
Revised and updated PR, please re-review when you have time. |
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.
This will be a great add to the docs! And the current wording makes sense to me
Description
Add a new Troubleshooting top-level topic to the Presto documentation, and (as the first entries in the topic) add a set of problem-solution pairs for deploying Presto to a sub-page in a new directory.
Motivation and Context
The idea of a troubleshooting Presto topic for the documentation has been discussed for a long time. Recently a coworker asked me for help installing Presto because they had followed the documentation in Deploying Presto and they encountered problems. I noticed that I had personally experienced each of his problems myself, and that the Presto doc addressed none of these.
I could have added these errors and their problems to Deploying Presto, but took this set of problem-solution pairs as an opportunity to propose the creation of a troubleshooting topic in the documentation.
Like the Presto C++ top-level documentation topic introduced in #21953, this PR creates the doc framework for troubleshooting content and provides a place in the Presto doc for similar content to be added over time. Additional content should not be added in this PR and is welcome as future PRs.
Impact
Readers can find solutions to problems presented in a format that describes the error they encounter, then (if one exists) a recommended fix for their problem.
Test Plan
Local doc builds.
Screenshots
Troubleshooting index page

Deploying Presto sub-page in the Troubleshooting section

Contributor checklist
Release Notes
Please follow release notes guidelines and fill in the release notes below.