-
Notifications
You must be signed in to change notification settings - Fork 6
temporal_rs v0.1 release post #210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! some comments here
blog/temporal-release/index.md
Outdated
@@ -0,0 +1,385 @@ | |||
# Temporal_rs release v0.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get that this is a release post, but i think we need a catchier title as many people reading this won't know what temporal_rs is..
"Powering Temporal in both V8 and Boa, Temporal_rs"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Temporal is finally shipping (and it's in Rust)" could be a good title
format (IXDTF) | ||
4. Utilities | ||
|
||
 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may just be me, but it looks like temporal_rs is providing those things rather than them being dependencies.
It may be good to have the dependencies on the far left, then temporal_rs, then the engines on the right (or bottom up if that doesn't work)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
blog/temporal-release/index.md
Outdated
background of the Temporal implementation in Boa and why `temporal_rs` | ||
was split into it's own crate, we'll go over the libraries general | ||
design, then we'll walk through a couple brief examples of using | ||
`temporal_rs`, and finally we'll talk about the FFI and engine adoption. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think somewhere in the first section we want "temporal_rs is the first Rust library to be used within V8, but more on that later" and you can link to the FFI section
as it displays the utility of the Temporal API using JavaScript and all | ||
of these examples are now usable from Rust as well. | ||
|
||
## FFI and engine adoption |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we want a visual in this section to show the engines and their conformance, or maybe its fine?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably relatively fine. I'd normally link to test262.fyi. But V8 is delayed on there
blog/temporal-release/index.md
Outdated
## Special thanks | ||
|
||
We'd like to thank all the contributors to `temporal_rs` for helping it | ||
get to 0.1. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
get to 0.1. | |
get to v0.1. |
blog/temporal-release/index.md
Outdated
|
||
## Special thanks | ||
|
||
We'd like to thank all the contributors to `temporal_rs` for helping it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'd like to thank all the contributors to `temporal_rs` for helping it | |
We'd like to thank all the [contributors](https://github.com/boa-dev/temporal/graphs/contributors) to `temporal_rs` for helping it |
The banner could be cool. Not exactly sure how to add it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whew, did an extensive review on this, since it's a really big milestone, so the announcement blog post must follow suit.
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can still add the banner and polish some more details, but the core post LGTM, so preemptively approving.
I added the banner as an image at the top of the post (coudn't get it to work in the front matter though) but glancing around docusaurus' site that may be the recommended method. |
Drafting a pull request for the v0.1 release. Merging is going to be dependent on two questions / tasks: - [x] What should the version for `timezone_provider` and `zoneinfo_rs` be? - [ ] Is the [release post](boa-dev/boa-dev.github.io#210) reviewed and ready? Regarding the question around versioning, I've left them still in the 0.0.x path until the APIs can be a bit more stabilized. But I'm open to adding them to a 0.1.0 version. My main concern is if we do make a breaking change to `timezone_provider` in the future (like stablizing the ZeroCompiledTzdbProvider) , then we may have to adjust the versions then for `timezone_provider` to be a 0.2.0 and `temporal_rs` to be a 0.1.1. I'd prefer to do a delayed 0.1 for those crates, but that is not an incredibly strong position.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks amazing!! Just some minor nitpicks 😄
- `ZoneInfo64TzdbProvider`, a provider using ICU's zoneinfo64 resource | ||
bundle. | ||
|
||
We hope to have a zerocopy compiled timezone provider available in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We hope to have a zerocopy compiled timezone provider available in the | |
We hope to have a `zerocopy` compiled timezone provider available in the |
(We could even add a link to https://docs.rs/zerocopy/latest/zerocopy. so readers unfamiliar with it can learn more.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "zero copy" isn't technically using zerocopy though, so we probably shouldn't link just yet (although there were some discussions that seemed to be happening at RustConf). That's meant as more of the concept, so maybe "zero copy" is better there.
Co-authored-by: Haled Odat <[email protected]>
Co-authored-by: Haled Odat <[email protected]>
Co-authored-by: Haled Odat <[email protected]>
Co-authored-by: Haled Odat <[email protected]>
Co-authored-by: Haled Odat <[email protected]>
We should address the question of “Why not 1.0?” So that should be added in the first section, if it’s not there later I’ll add it |
add info about v0.1
info about tests passed
quote about diplomat
fix up quotes
"almost 2+ year is an oxymoron", just remove the "almost"
adding links
description isn't needed
This is a first pass at a release post for temporal_rs 0.1.
I haven't reread it just yet beyond the initial writing, so there could be some awkward wording. Feel free to take a look, make changes, or general feedback.