docs: rewrite README - #16
Merged
Merged
Conversation
Rework the README so it reads as conventional project documentation and correct the statements that did not match the code. Badges: - Point the Maven Central badge at central.sonatype.com and add a License badge, matching the other CodeLibs OpenSearch plugins Corrections: - Fix the configsync.scroll_size default, which is 1 and not 1000 - Fix the storage index name. configsync.index defaults to "configsync"; ".configsync" is the separate pattern registered as a system index - Remove the claim that files are stored securely, since they are stored as ordinary index documents with no additional protection - Note that configsync.flush_interval is a dynamic setting Content: - Document the GET /_configsync/wait endpoint and its status and timeout parameters, which were missing - Document the list parameters of GET /_configsync/file: sort, fields, from and size - Document configsync.xpack.security.user, which was missing - Give each endpoint its own section with a parameter table, and add the installation and build sections the other plugins have
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: rewrite README
Rework the README so it reads as conventional project documentation and
correct the statements that did not match the code.
Badges:
badge, matching the other CodeLibs OpenSearch plugins
Corrections:
".configsync" is the separate pattern registered as a system index
as ordinary index documents with no additional protection
Content:
parameters, which were missing
from and size
installation and build sections the other plugins have