Settings backwards compat documentation #15
Conversation
dblock
force-pushed
the
settings-backwards-compat
branch
2 times, most recently
from
72117c7 to
f1b41a6
Compare
Signed-off-by: dblock <[email protected]>
dblock
force-pushed
the
settings-backwards-compat
branch
from
f1b41a6 to
d0f0547
Compare
|
|
||
| 7. Document your newly renamed settings. | ||
|
|
||
| TODO |
There was a problem hiding this comment.
@aetter what should we write here? Where do I make changes for job-scheduler settings public documentation?
There was a problem hiding this comment.
Hey @dblock, we actually have no user-facing content on job-scheduler since it plays such a supporting role. We deprioritized it early on and have never had a reader ask for anything. I'm happy to add a new top-level section to the documentation if you have content that you'd like to get out there. Just let me know. Otherwise, the most likely place is the job-scheduler README.
There was a problem hiding this comment.
@aetter What's another plugin link/example that we can put here?
There was a problem hiding this comment.
Alerting is a decent example since the settings page also includes the managed indices and their purposes, which I assume might change during a migration. https://docs-beta.opensearch.org/docs/alerting/settings/#alerting-settings
There was a problem hiding this comment.
Ok, and where's the source for that?
There was a problem hiding this comment.
We have a link in the lower left to "edit this page" that should send you to the source. In this case, it's https://github.com/opensearch-project/documentation-website/blob/main/docs/alerting/settings.md
There was a problem hiding this comment.
Thanks. I PRed #18.
It looks like we did a bunch of bulk replacement in the docs. Note that these don't correspond to reality in plugins for beta1 currently as none of the indices or settings should have been changed.
Description
Assuming we go with this, documented updating settings. See opensearch-project/job-scheduler#20 for a working implementation. On top of #14.
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.