Skip to content
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

Document that most config properties are set on all nodes #12688

Merged
merged 1 commit into from
Jun 22, 2022

Conversation

jhlodin
Copy link
Contributor

@jhlodin jhlodin commented Jun 3, 2022

Description

There's a recurring question in the Trino slack, of beginners wondering which nodes require what configuration properties. This PR helps set the expectation that, by default, admins should assume a property is set on all nodes (coordinator and workers) unless documented otherwise.

Is this change a fix, improvement, new feature, refactoring, or other?

Improvement

Is this a change to the core query engine, a connector, client library, or the SPI interfaces? (be specific)

Documentation

How would you describe this change to a non-technical end user or system administrator?

Improves the properties documentation to be more clear about how they should be configured.

Related issues, pull requests, and links

Documentation

( ) No documentation is needed.
(x) Sufficient documentation is included in this PR.
( ) Documentation PR is available with #prnumber.
( ) Documentation issue #issuenumber is filed, and can be handled later.

Release notes

(x) No release notes entries required.
( ) Release notes entries required with the following suggested text:

# Section
* Fix some things. ({issue}`issuenumber`)

@cla-bot cla-bot bot added the cla-signed label Jun 3, 2022
@jhlodin jhlodin added the docs label Jun 3, 2022
@jhlodin
Copy link
Contributor Author

jhlodin commented Jun 3, 2022

There may be other places in the docs where this can be better clarified, but I think this is a simple addition. To do this in more depth would probably require an overhauling of Trino installation instructions.

docs/src/main/sphinx/admin/properties.rst Outdated Show resolved Hide resolved
@jhlodin jhlodin force-pushed the jl/prop-location-clarification branch from def5c37 to db0b8f5 Compare June 3, 2022 21:42
@jhlodin jhlodin requested a review from mosabua June 15, 2022 18:13
@martint martint merged commit 9da4356 into trinodb:master Jun 22, 2022
@github-actions github-actions bot added this to the 387 milestone Jun 22, 2022
@jhlodin jhlodin deleted the jl/prop-location-clarification branch June 22, 2022 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants