This repository has been archived by the owner on Nov 15, 2022. It is now read-only.
docs(routes): indent the routes example in README #463
Conversation
This file contains 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
|
@containscafeine @cdrage can you PTAL? |
concaf
reviewed
Nov 21, 2017
docs/examples/routes/README.md
Outdated
|
|
||
| Much like other resource definitions in Kedge, routes have been implemented | ||
| by merging `RouteSpec` and `ObjectMeta`, which would mean that you can | ||
| define fields like `name` and the rest of the RouteSpec at the same level. | ||
|
|
||
| An example would be - | ||
| Snippet from [httpd.yml](httpd.yml): |
docs/examples/routes/README.md
Outdated
| name: httpd | ||
| ``` | ||
|
|
||
| A much detailed example might look like this: |
There was a problem hiding this comment.
A "more" detailed example ...
Right now the way routes example is explained in it's README, it is not very helpful and can confuse user, so placing it in right indentation.
surajssd
force-pushed
the
clarify-example-readme
branch
from
448584b
to
1240e55
Compare
|
@containscafeine done! |
|
LGTM |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Right now the way routes example is explained in it's README, it is
not very helpful and can confuse user, so placing it in right
indentation.
Fixes #402