## What changed?
<!-- Describe what has changed in this PR -->
A refresh of our README.
| Before | After |
|--------|--------|
| <img width="919" alt="Screenshot 2025-04-07 at 2 48 07 PM"
src="https://github.com/user-attachments/assets/92485c3d-770a-493d-86a3-ca2331d19a55"
/> | <img width="929" alt="Screenshot 2025-04-07 at 2 49 21 PM"
src="https://github.com/user-attachments/assets/f0dc4b4f-4a6f-4037-b789-a0fa027901b6"
/> |
[See it
here](https://github.com/stephanos/temporal/tree/readme-refresh).
## Why?
<!-- Tell your future self why have you made these changes -->
I saw the https://github.com/jj-vcs/jj README and felt our README could
learn a thing or two from that one.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
## What changed?
<!-- Describe what has changed in this PR -->
Fixed README badge links to not only look pretty but also redirect you.
Try it here:
dcabb2df65/README.md
## What changed?
<!-- Describe what has changed in this PR -->
Before
<img width="919" alt="Screenshot 2025-03-14 at 10 04 00 AM"
src="https://github.com/user-attachments/assets/71372c24-f489-4cd0-b823-45155587839b"
/>
After
<img width="928" alt="Screenshot 2025-03-14 at 10 04 20 AM"
src="https://github.com/user-attachments/assets/142f074e-78ae-49e8-8331-733b1360a1ea"
/>
## Why?
<!-- Tell your future self why have you made these changes -->
Improve the first impression of a visitor:
- "All Tests" badge is either green (which doesn't really mean much); or
is red due to a flaky test (which looks bad)
- "Codecov" badge looks worse than it is: it should be yellow but is
orange.
- "Codecov" badge updates in real-time; meaning it shows lower numbers
during a test run
- use consistent lowercase letters
## What changed?
<!-- Describe what has changed in this PR -->
Consolidate links for contributors in the README.
## Why?
<!-- Tell your future self why have you made these changes -->
Remove dead links and streamline link discovery.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
## What changed?
<!-- Describe what has changed in this PR -->
Replaced Coveralls code coverage badge with CodeCov's.
## Why?
<!-- Tell your future self why have you made these changes -->
We're replacing Coveralls with CodeCov.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
## What changed?
Make link to CONTRIBUTING.md in the README slightly more explicit.
## Why?
People outside server team sometimes need to run the server against
`main` and it's not obvious how to.
## What changed?
<!-- Describe what has changed in this PR -->
I reorganized our docs into `docs/{admin,architecture,development}`.
## Why?
<!-- Tell your future self why have you made these changes -->
We discussed this internally, but I believe this is a better
segmentation for the different audiences looking at our docs. I plan on
adding more stuff to docs/admin like metrics and dynamic config docs.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
I'm mainly looking for broken links.
- I went through each markdown file in docs manually.
- I looked through all inspection errors in the IDE.
- I looked at all references to "docs/" or "develop/" in our code.
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
## What changed?
<!-- Describe what has changed in this PR -->
Remove buildkite configs and references.
## Why?
<!-- Tell your future self why have you made these changes -->
Buildkite is no longer used.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
Existing tests.
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
No.
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
N/A
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
No.
<!-- Describe what has changed in this PR -->
**What changed?**
Rename leftover `master` to `main`.
<!-- Tell your future self why have you made these changes -->
**Why?**
`master` branch was renamed to `main` but some places still reference
`master`.
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
N/A
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
No risks.
<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
No.
<!-- Describe what has changed in this PR -->
**What changed?**
Replaced docker based server startup with Temporal CLI dev server
<!-- Tell your future self why have you made these changes -->
**Why?**
Aligning server readme with the docs
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
* Update readme
* Fix casing
* Add a better video still
* Address feedback
* Update statement about samples
* Recommit video.png with LFS settings.
* Cut a sentence to make intro more concise
* remove docs dir
because docs are now external and these are outdated.
* Remove in-repo docs links in readme
and PROPOSALS.md along with adding a pointer to the proposals repo
* remove doc added after docs removal
because this isn't where docs go now
* add feature request link to README
in the section about contributing and our proposals repo
Rename generated binaries:
- cadence -> temporal
- cadence-server -> temporal-server
- cadence-canary -> temporal-canary
- cadence-sql-tool -> temporal-sql-tool
- cadecne-cassandra-tool -> temporal-cassandra-tool
Moved core schema files for all database implementation to be under temporal folder.
Also used 'temporal' as keyspace or database name for core schema.
Renamed all environment variable to use TEMPORAL instead of CADENCE.
Renamed all docker scripts to references to point to new executables and mention
temporal.
Change reference to buildkite pipelines for temporal.
* Rename IDL files to move then under temporalio/temporal
* Rename ProjectRoot in makefile represent new repository
* Update go.mod to represent new repository
* Update all imports to temporalio/temporal package
* Fix tests to work after renaming
