Skip to content

Add post about stabilizing intra-doc links #689

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

Merged
merged 8 commits into from
Sep 17, 2020

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Sep 10, 2020

cc @Manishearth
I set the date as tomorrow, but I don't have strong opinions about when to publish.

@jyn514 jyn514 added needs review content An issue related to an article. labels Sep 10, 2020
@jyn514 jyn514 requested a review from a team September 10, 2020 21:25
@Manishearth
Copy link
Member

I'm hoping to hold off until we know when intra doc is going to stabilize

@Manishearth
Copy link
Member

cc @QuietMisdreavus if you wanna take a look

@Manishearth
Copy link
Member

Should we mention somewhere that the feature has been auto enabled on nightly and thus on docs.rs somewhere? (And that this blog post is a way to signal "you really should start using this now")

@GuillaumeGomez
Copy link
Member

@Manishearth Oh that's a good point. I think we should definitely mention it.

@jyn514
Copy link
Member Author

jyn514 commented Sep 13, 2020

Should we mention somewhere that the feature has been auto enabled on nightly and thus on docs.rs somewhere? (And that this blog post is a way to signal "you really should start using this now")

I'm not really comfortable encouraging people to use unstable features ... In general it makes me uncomfortable that all docs are built with nightly by default, but I'm not sure how docs.rs can change that without breaking the entire ecosystem of docs.

@Manishearth
Copy link
Member

@jyn514 no, you misunderstand, we're encouraging them to use it more now that it is stable.

@jyn514
Copy link
Member Author

jyn514 commented Sep 13, 2020

Oh I see, we're saying to skip the 12-week delay until it hits stable 😆 I guess that works, I'll add that.

@Manishearth
Copy link
Member

@jyn514 no no!

The reason I want that in is that some people will be confused as to why we're talking about a feature that has been around forever. This clarifies what has changed, and the important thing is that now we strongly recommend people use it. It's not about the 12 week period, in fact we should probably publish this after the feature hits beta.

@jyn514
Copy link
Member Author

jyn514 commented Sep 13, 2020

I pushed a change but I'm not super confident in the wording ... maybe you should write this bit :P

@camelid
Copy link
Member

camelid commented Sep 15, 2020

Might it be better to post this on the main Rust blog so that more people see it?

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
@jyn514
Copy link
Member Author

jyn514 commented Sep 15, 2020

Not sure after last time ... @pietroalbini what do you think about posting this on the main blog instead of inside-rust?

@Manishearth
Copy link
Member

I'm okay with either, personally. Inside rust doesn't really require approval, but for the main blog the core team should consider this important enough. Idk if they will.

@pietroalbini
Copy link
Member

This seems more like a "behind the scenes" post on the history of the feature and the challenges implementing it, rather than an announcement of what the feature is and when it will be stabilized.

I personally think that's content better suited for Inside Rust, but I'm happy to raise the question to the rest of the Core Team if you so wish.

@jyn514
Copy link
Member Author

jyn514 commented Sep 16, 2020

I agree with that, let's keep it on inside-rust.

@Manishearth
Copy link
Member

Seems good. The only reason it might work on the main blog is because it is an interesting journey, but that's not necessarily the right bar.

@jyn514
Copy link
Member Author

jyn514 commented Sep 17, 2020

This week in rust just posted about the stabilization PR, so I think we should publish this today.

@pietroalbini pietroalbini merged commit b19064b into rust-lang:master Sep 17, 2020
@jyn514 jyn514 deleted the intra-doc-links branch September 17, 2020 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content An issue related to an article. needs review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants