-
Notifications
You must be signed in to change notification settings - Fork 110
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
docs(release): add support Tiers and supported platforms per Tier #4773
Conversation
This documentation is based on Rust supported platforms and tiers, and adapted to Zebra
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.
This looks like a good start!
The target tier policy has a lot of rules that apply to the Rust compiler, but not Zebra. I'd suggest deleting those rules first, before making any other changes.
Zebra's project structure and processes are also different, so we'll need to update the remaining rules to match what we actually do. I added a comment the first time I saw each difference.
Since we copied these docs from the Rust project, can we credit them at the end of the doc?
We also recently set up platform support policies for |
Thanks for the fixes, let me know when you want me to review this PR again. |
@ZcashFoundation/general-rust-reviewers this is ready for general review. @str4d thank you for sharing |
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 great!
I don't think we need to add an explanation about Windows, it's documented in tickets if someone wants to dig for information.
I won't approve for now so that others can take a look
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, thanks for all the updates!
I'll finish reviewing the detailed policy tomorrow.
Co-authored-by: teor <teor@riseup.net>
…to doc-release-rfc
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 finished my detailed review. It looks really good, I think it's pretty clear about what we want.
I noticed some Rust compiler-specific language, and some unclear or incorrect details.
My suggestions to fix them are in PR #4791.
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.
Thank you for all your work tracking down these details.
I made a bunch of final suggestions to resolve all outstanding comments.
Feel free to accept or reject them, I think we're getting to the final details now.
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: teor <teor@riseup.net>
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 great, thanks!
Did you want to open a ticket to update the README and book indexes, or add it to the list of tasks in the release process ticket?
Things have changed a lot since our original release process draft. So the ticket and draft might be too complicated - we might want to delete the outdated parts before we start.
Added it to the list of tasks in the release process ticket. |
Motivation
As we get near to our Release Candidate, we should decide on which platforms we're going to support and the level of support and guarantees we'd like to ensure for each.
We've deploying with Debian in Docker and build with Ubuntu and MacOS in our CI, but we haven't defined an strategy around these platforms or how we're going to guarantee support, if any.
Fixes #4448
Solution
This documents are based on Rust's approach with Tiers and Supported platforms https://github.com/rust-lang/rust/tree/master/src/doc/rustc/src
Review
Most people from @ZcashFoundation/zebra-team should have a look at this
Reviewer Checklist
windows
support?Follow Up Work
supported-platforms.md
andtarget-tier-policies.md