-
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
[documentation] revision of redis-hbo-provider.rst #21831
[documentation] revision of redis-hbo-provider.rst #21831
Conversation
@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: |
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.
Are there default values for these configuration properties that could be added to this table?
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.
I have added some defaults, most of the other config properties will need user enviroment specific changes
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.
Actually we can add a default column
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! 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.

I requested another review from you when you have time because I made this change after your first review.
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.
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
)?
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.
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?
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.
I have added some examples below in the documentation though
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.
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?
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 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: |
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.
I have added some defaults, most of the other config properties will need user enviroment specific changes
8c9f94d
to
f1fc577
Compare
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
Release Notes