Repository navigation
Make the README a short, uniform guide for newcomers - #39
Merged
Merged
Conversation
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
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.
The README was a few very long paragraphs, so a first install meant reading all of them. It now uses the same seven sections as the other Weir repositories, states what the chart provides and what you provide, and walks through one install, including the client label and address that a first user would otherwise miss.
The configuration, monitoring, autoscaling, operations and development detail moved to
docs/, with headings added, one sentence moved under a better heading and the SDK version updated to v0.23.1, the first licensed release. Validation:make testpasses andhelm templaterenders the quick start. Remaining gap: it has not been applied to a real cluster, and chart CI installs only the Search example.