Skip to content
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

Merged
merged 6 commits into from
Sep 18, 2019
Merged

"Upcoming docs.rs changes" #403

merged 6 commits into from
Sep 18, 2019

Conversation

pietroalbini
Copy link
Member

@pietroalbini pietroalbini commented Sep 16, 2019

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.

posts/2019-09-18-upcoming-docsrs-changes.md Outdated Show resolved Hide resolved
posts/2019-09-18-upcoming-docsrs-changes.md Show resolved Hide resolved
posts/2019-09-18-upcoming-docsrs-changes.md Outdated Show resolved Hide resolved
posts/2019-09-18-upcoming-docsrs-changes.md Outdated Show resolved Hide resolved
posts/2019-09-18-upcoming-docsrs-changes.md Outdated Show resolved Hide resolved
posts/2019-09-18-upcoming-docsrs-changes.md Outdated Show resolved Hide resolved
posts/2019-09-18-upcoming-docsrs-changes.md Outdated Show resolved Hide resolved
@shepmaster
Copy link
Member

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?

I think you could even say "Pietro Albini and the Rust Infrastructure Team". Self-promotion is good when deserved!

@pietroalbini
Copy link
Member Author

Addressed most of the review comments and replied to the others.

@pietroalbini
Copy link
Member Author

Updated the post to mention the deploy date of the breaking changes is going to be September 30th.

@pietroalbini
Copy link
Member Author

Addressed all the requested changes.

@pietroalbini
Copy link
Member Author

@rust-lang/core could I get an approval from y'all before publishing the post?

@Mark-Simulacrum
Copy link
Member

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.

@pietroalbini pietroalbini merged commit bd045f2 into master Sep 18, 2019
@pietroalbini pietroalbini deleted the docsrs-changes branch September 18, 2019 13:58
Copy link
Contributor

@nikomatsakis nikomatsakis left a 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
Copy link
Contributor

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

...

@nikomatsakis
Copy link
Contributor

oh, wait this was already posted :P

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants