Repository navigation
docs(readme): replace the install, port and action-input tables with sentences - #687
Merged
Merged
Conversation
…sentences The components list, the port map and the action inputs each become a sentence. Namespaces are configurable and shown by kates deploy --dry-run, local URLs are printed by kates ports, and every action input is described in action.yml.
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's three reference tables become short sentences:
kates deployinstalls: one sentence naming the components. Namespaces are configurable, andkates deploy --dry-runprints every release and namespace.kates portsexposes the services and prints each local URL; the two-forwarder port map and its footnote are gone. The Grafana sign-in on Kind stays.action.yml, which describes each one.Docs only, no code change.