Updated docs/deployment.md with reordering subtopics #475
Conversation
ideepika
requested review from
black-adder,
pavolloffay,
vprithvi and
yurishkuro
as code owners
|
Thanks for this contribution, @dexter816 ! I added a few comments to the review but it looks good in general! I'm curious, though, as to what's different on this PR compared to #473 . If this is the same task, then you could add more commits to that PR. If you are unsure on how to update a PR, let me know and I can guide you. I would also ask you to squash the commits from this PR, as there seems to be a merge commit on it. You can squash the commits using |
docs/deployment.md
Outdated
| ``` | ||
| or if you don't have the source code | ||
| ``` | ||
| docker run -e MODE=... jaegertracing/jaeger-cassandra-schema |
There was a problem hiding this comment.
Can you replace by the actual command? I think I typed this from memory and I might be wrong :)
docs/deployment.md
Outdated
|
|
||
| ### Discovery System Integration | ||
| ```sh |
There was a problem hiding this comment.
This looks odd. Perhaps this needs to be removed?
docs/deployment.md
Outdated
| across several collectors ([issue 213](https://github.com/uber/jaeger/issues/213)). | ||
| #### Shards and Replicas for ElasticSearch indices | ||
|
|
||
| ======= |
There was a problem hiding this comment.
This also looks odd:
Some editors, such as Visual Studio Code, have a markdown viewer that might be useful:
docs/deployment.md
Outdated
|
|
||
| Example: | ||
| ``` | ||
| docker run -it --rm -p14267:14267 -p14268:14268 |
There was a problem hiding this comment.
This should either be all in one line, or there should be a \ at the end of the line, so that readers can just copy/paste from the instructions to the terminal.
docs/deployment.md
Outdated
|
|
||
| ## Query Service & UI | ||
|
|
||
| **jaeger-query** serves the API endpoints and a React/Javascript UI. | ||
| The service is stateless and is typically run behind a load balancer, e.g. nginx. | ||
|
|
||
| An example to test Query Service: | ||
| ``` | ||
| docker run -it -p16686:16686 jaegertracing/jaeger-query:latest |
There was a problem hiding this comment.
Same as above: either add all in one line, or add \ at the end of the line.
|
@jpkrohling thanks for the review ,yeah I was unsure how to update pull request ,I made the amendments you suggested , looking at updating PR , thanks again :) |
ideepika
changed the title
docs/deployment.md
Outdated
| In the future we will support different service discovery systems to | ||
| dynamically load balance | ||
| across several collectors ([issue | ||
| 213](https://github.com/uber/jaeger/issues/213)). |
There was a problem hiding this comment.
what is the purpose of these formatting changes? they seem to make this diff twice as big as it needs to be
There was a problem hiding this comment.
Fixed that ,thanks :)
Changes made: -replaced ElasticSearch to Elasticsearch -updated example commands for better readibilty -minor updates in docs/deployment.md Closes: #472 Signed-off-by: Deepika Upadhyay deepikaupadhyay01@gmail.com
|
Closing docs have been moved to https://github.com/jaegertracing/documentation repo |
No description provided.