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

[documentation] revision of redis-hbo-provider.rst #21831

Merged
merged 1 commit into from
Feb 9, 2024

Conversation

steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Jan 31, 2024

Description

Noticed the numbering of the steps in Production Setup of Redis HBO Provider was out of order and fixed that. Also minor edits of punctuation, formatting, and links.

Motivation and Context

Readers might be confused by the step numbering.

Impact

Documentation.

Test Plan

Built docs locally and reviewed the local build of the page.

Contributor checklist

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

== NO RELEASE NOTE ==

@steveburnett steveburnett requested a review from a team as a code owner January 31, 2024 19:23
@github-actions github-actions bot added the docs label Jan 31, 2024
@steveburnett
Copy link
Contributor Author

@jaystarshot, I'd appreciate your review of my suggested changes to this docs page. Thanks!

Create ``etc/catalog/redis-provider.properties`` to mount the Redis HBO Provider Plugin, replacing the properties as appropriate:
Create ``etc/catalog/redis-provider.properties`` to mount the Redis HBO Provider Plugin.

Edit the configuration properties as appropriate:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there default values for these configuration properties that could be added to this table?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added some defaults, most of the other config properties will need user enviroment specific changes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually we can add a default column

Copy link
Contributor Author

@steveburnett steveburnett Feb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I added a default column in the second table - the four properties in "Coordinator Configuration for Historical Based Optimization", as you provided default values for all of them. Here's a screenshot of my local build showing the Default Value column added to that table.

Screenshot 2024-02-01 at 9 49 14 AM

I requested another review from you when you have time because I made this change after your first review.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there default values that could be documented for any of the eight properties in the first table (coordinator through hbo.redis-provider.cluster-mode-enabled)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we don't have a default value set as of now. I will try to add default values in a PR soon.
Would it work if we added a sample property column?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added some examples below in the documentation though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we don't have a default value set as of now. I will try to add default values in a PR soon. Would it work if we added a sample property column?

I see the examples in the codeblock, those are a big help for the user.

Docs should describe the current state of the software - if the default values for those don't exist then we don't need to document them. When you add default values in a future PR, we can document those values at that time by updating this page as part of that PR. Does that seem reasonable?

@steveburnett steveburnett changed the title revision of redis-hbo-provider.rst [documentation] revision of redis-hbo-provider.rst Jan 31, 2024
Copy link
Member

@jaystarshot jaystarshot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the revision!

Create ``etc/catalog/redis-provider.properties`` to mount the Redis HBO Provider Plugin, replacing the properties as appropriate:
Create ``etc/catalog/redis-provider.properties`` to mount the Redis HBO Provider Plugin.

Edit the configuration properties as appropriate:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added some defaults, most of the other config properties will need user enviroment specific changes

@steveburnett steveburnett merged commit d16053d into prestodb:master Feb 9, 2024
57 checks passed
@steveburnett steveburnett deleted the steveburnett-redis-hbo branch February 9, 2024 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants