Update readme #861
Merged
Update readme #861
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
wxing1292
reviewed
Oct 15, 2020
| # Temporal | ||
|
|
||
| Temporal is a microservice orchestration platform which enables developers to build scalable applications without sacrificing productivity or reliability. | ||
| Temporal server executes units of application logic, Workflows, in a resilient manner that automatically handles intermittent failures, and retries failed operations. |
There was a problem hiding this comment.
No, we decided to cap all our important entities. Workflow, Activity, what else?
There was a problem hiding this comment.
I was told we need to capitalize in our docs core concepts like Workflows and Activities.
There was a problem hiding this comment.
not sure whether *Workflows* is better?
wxing1292
reviewed
Oct 15, 2020
wxing1292
reviewed
Oct 15, 2020
wxing1292
reviewed
Oct 15, 2020
README.md
Outdated
Comment on lines
20
to
35
| Try out the sample recipes for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) to get started. | ||
| Clone or download samples for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) and try to run them against the local Temporal server. |
There was a problem hiding this comment.
i guess the previous version looks better?
There was a problem hiding this comment.
There is no "recipes" any more. I like new version. Just would remove word "try" and rephrase a little.
wxing1292
reviewed
Oct 15, 2020
wxing1292
reviewed
Oct 15, 2020
alexshtin
reviewed
Oct 15, 2020
README.md
Outdated
|
|
||
| ### Run the Samples | ||
|
|
||
| Try out the sample recipes for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) to get started. | ||
| Clone or download samples for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) and try to run them against the local Temporal server. | ||
| We have a number of [HelloWorld type scenarios](https://github.com/temporalio/samples-java#helloworld) available. |
There was a problem hiding this comment.
There is "hello world" in go too.
There was a problem hiding this comment.
But only one. Is it worth linking to it from here?
alexshtin
reviewed
Oct 15, 2020
wxing1292
approved these changes
Oct 15, 2020
samarabbas
approved these changes
Oct 15, 2020
rylandg
approved these changes
Oct 15, 2020
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.
What changed?
Revamped readme for clarity.
Why?
Help people understand what Temporal is and how to start with it.
How did you test it?
N/A
Potential risks
N/A