-
Notifications
You must be signed in to change notification settings - Fork 299
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
"Upcoming docs.rs changes" #403
Conversation
e3a511b
to
d4f8e77
Compare
I think you could even say "Pietro Albini and the Rust Infrastructure Team". Self-promotion is good when deserved! |
Addressed most of the review comments and replied to the others. |
Updated the post to mention the deploy date of the breaking changes is going to be September 30th. |
Addressed all the requested changes. |
@rust-lang/core could I get an approval from y'all before publishing the post? |
I've asked in core on Discord for approval and I or someone else will circle back here in a few hours to approve/unapprove; personally I think we should be fine to go ahead though. |
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 great! Left a nit.
author: The Rust Infrastructure Team | ||
--- | ||
|
||
On September 30th breaking changes will be deployed to the [docs.rs] build |
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'd rephrase this to emphasize the benefits first.
On September 30th, we'll be upgrading docs.rs to use a stronger sandbox when building documentation. This change is not expected to effect the vast majority of users, but it is technically a breaking change, so we want to be sure everyone is aware of it.
what is docs.rs?
[docs.rs] is a free service building and hosting documentation ... (as before)
What will change
...
oh, wait this was already posted :P |
As we agreed in the last leadership meeting this is a blog post explaining the upcoming changes in the docs.rs build environment. The changes are implemented in rust-lang/docs.rs#407.
We still need to schedule a day for the deployment, and we'll discuss the date in the infrastructure team meeting on 2019-09-17, hence the publishing date of the post on 2019-09-18. I want the post to be out in advance so people have time to test and adapt their crates.
As the author of the post I chose "The Rust Infrastructure Team", as I'm the one who mainly did the design and implementation work (all of this with my infra hat) and this is something infra really wants. Do y'all think it's appropriate or should I change it to another author?
r? @Mark-Simulacrum
cc @rust-lang/core @rust-lang/infra @rust-lang/rustdoc
Edit: oh yeah, this also includes a small commit to the blog engine to ignore vim's swapfiles.