Refresh the docs with better language #648
Merged
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
Signed-off-by: Yuri Shkuro <[email protected]>
✅ Deploy Preview for romantic-neumann-1959d7 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
yurishkuro
commented
Aug 22, 2023
| why: | | ||
| As on-the-ground microservice practitioners are quickly realizing, the majority of operational problems that arise when moving to a distributed architecture are ultimately grounded in two areas: **networking** and **observability**. It is simply an orders of magnitude larger problem to network and debug a set of intertwined distributed services versus a single monolithic application. | ||
| Distributed tracing observability platforms, such as Jaeger, are essential for modern software applications that are architected as microservices. Jaeger maps the flow of requests and data as they traverse a distributed system. These requests may make calls to multiple services, which may introduce their own delays or errors. Jaeger connects the dots between these disparate components, helping to identify performance bottlenecks, troubleshoot errors, and improve overall application reliability. Jaeger is 100% open source, cloud native, and infinitely scalable. |
There was a problem hiding this comment.
This was fun to write with the help of Bard, and using the writing styles of Alan Turing and Leslie Lamport.
|
@albertteoh could you review? |
albertteoh
reviewed
Aug 24, 2023
| - You need [Go toolchain](https://golang.org/doc/install) installed on your machine to run from source | ||
| (see [go.mod](https://github.com/jaegertracing/jaeger/blob/master/go.mod) file for required Go version). | ||
| - Requires a [running Jaeger backend](#all-in-one) to view the traces. | ||
| We recommend running Jaeger and HotROD via `docker compose`. In order to run it from source you need: |
There was a problem hiding this comment.
In order to run it from source you need:
This sentence feels like we're almost conflating docker compose with running from source, and I think the second sentence should belong under From Source since it's not relevant in either With Docker Compose or With Docker.
There was a problem hiding this comment.
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.
Description of the changes