Skip to content

Add rustdoc team processes - #852

Merged
fmease merged 5 commits into
rust-lang:masterfrom
GuillaumeGomez:rustdoc
Aug 5, 2025
Merged

Add rustdoc team processes#852
fmease merged 5 commits into
rust-lang:masterfrom
GuillaumeGomez:rustdoc

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented May 21, 2025

Copy link
Copy Markdown
Member

cc @rust-lang/rustdoc

Rendered

Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/resources.md
Comment threadsrc/rustdoc/README.md Outdated
Comment threadsrc/rustdoc/meetings.md
Comment threadsrc/rustdoc/membership.md
@ehuss

Copy link
Copy Markdown
Contributor

Can you also add the rustdoc team to triagebot.toml for this directory and give yourselves permissions in https://github.com/rust-lang/team/blob/HEAD/repos/rust-lang/rust-forge.toml?

Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated

@aDotInTheVoidaDotInTheVoid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! I'm very happy to see this written down.

Comment threadsrc/rustdoc/membership.md Outdated
Comment threadsrc/rustdoc/membership.md Outdated
Comment threadsrc/rustdoc/README.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/membership.md
Comment threadsrc/rustdoc/membership.md Outdated
Comment threadsrc/rustdoc/membership.md Outdated
@fmeasefmease added T-rustdoc Team: rustdoc needs-fcp This change is insta-stable, so needs a completed FCP to proceed. labels May 21, 2025
@fmease

fmease commented May 21, 2025

Copy link
Copy Markdown
Member

(This PR will obviously need a T-rustdoc FCP to make it official once most things have been sufficiently fleshed out)

@fmeasefmease added the S-waiting-on-team Status: Awaiting review/feedback/decision from relevant team(s) label May 21, 2025

@ManishearthManishearth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall this seems pretty good!

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

(This PR will obviously need a T-rustdoc FCP to make it official once most things have been sufficiently fleshed out)

Absolutely!

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

I added the change in triagebot.toml as suggested by @ehuss.

I went through all comments.

@fmease: Hopefully I clarified that the rustdoc "groups" are not full-fledged teams and as such, to be part of them, you need to be a member of the rustdoc team.

Comment threadsrc/rustdoc/membership.md
Comment threadsrc/rustdoc/meetings.md Outdated
Comment threadsrc/rustdoc/meetings.md Outdated
Comment threadsrc/rustdoc/meetings.md Outdated

@lolbinarycatlolbinarycat left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few nitpicks

Comment threadsrc/rustdoc/README.md
Comment threadsrc/rustdoc/membership.md Outdated
Comment threadsrc/rustdoc/membership.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/meetings.md Outdated

@apirainoapiraino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a comment after a cursory read.

Great work @GuillaumeGomez !

Comment threadsrc/rustdoc/calendar.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc branch 2 times, most recently from 4da4ad9 to ab7ee18CompareMay 22, 2025 12:41
Comment threadsrc/rustdoc/calendar.md
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc branch 2 times, most recently from e92f236 to cc605f3CompareMay 22, 2025 20:53

@camelidcamelid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks great! I left a few comments about small clarifications, but the overall charter looks excellent.

Comment threadsrc/rustdoc/index.md Outdated
Comment threadsrc/rustdoc/meetings.md Outdated
Comment threadsrc/rustdoc/membership.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
Comment threadsrc/rustdoc/proposals-and-stabilization.md Outdated
@rfcbot

Copy link
Copy Markdown

🔔 This is now entering its final comment period, as per the review above. 🔔

psst @GuillaumeGomez, I wasn't able to add the final-comment-period label, please do so.

@camelidcamelid added the final-comment-period Will be merged/postponed/closed in ~10 calendar days unless new substational objections are raised. label Jul 8, 2025
@lolbinarycat

Copy link
Copy Markdown
Contributor

I think that we should have a section for what happens if you get assigned as a reviewer on a PR that you don't have the time or experience to review properly, such as if it's a large change to a sub-component you haven't worked with before. Having a policy for this would probably be quite helpful for any new team members.

@fmease

fmease commented Jul 9, 2025

Copy link
Copy Markdown
Member

I think that we should have a section for what happens if you get assigned as a reviewer on a PR that you don't have the time or experience to review properly, such as if it's a large change to a sub-component you haven't worked with before.

This is already covered. See src/rustdoc/reviews.md:

Review Policy

The rustdoc team follows the same review policy as the compiler team. Take a look at
their chapter about it.

which delegates to compiler/reviews.md which in turn states (excerpts):

Basic Reviewing Requirements

There are a number of requirements that need to be met in order for reviewing to
be effective:

  • Reviewers must have a sufficient understanding of the code under review.
    […]
  • Reviewers must have a good idea on whether they are the right person to approve the change.
    […]

(see linked documents for more details)

@rfcbot

Copy link
Copy Markdown

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

This will be merged soon.

psst @GuillaumeGomez, I wasn't able to add the finished-final-comment-period label, please do so.

@fmeasefmease added finished-final-comment-period The final comment period is finished for this RFC. disposition-merge This RFC is in PFCP or FCP with a disposition to merge it. labels Jul 18, 2025
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Need approval from @apiraino and @notriddle since they requested changes to be able to merge. :)

@apirainoapiraino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left 2 nits but otherwise LGTM 👍

@apirainoapiraino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:rocket: emoji for me

@notriddle

Copy link
Copy Markdown
Contributor

👍

Comment threadsrc/rustdoc/membership.md
@fmease

fmease commented Aug 4, 2025

Copy link
Copy Markdown
Member

The GH interface tells me that merging is still blocked because all comments must be resolved first.

I've therefore gone through all unresolved comments and checked if they've been addressed and if so marked them as resolved.

There's now a single comment left to be addressed, namely #852 (comment). It's only a minor issue that is relatively easy to resolve. Once that's done we can merge this :)

@fmease
fmease merged commit 57efdc9 into rust-lang:masterAug 5, 2025
1 check passed
@rustbotrustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 5, 2025
@GuillaumeGomez
GuillaumeGomez deleted the rustdoc branch August 5, 2025 12:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

disposition-mergeThis RFC is in PFCP or FCP with a disposition to merge it.final-comment-periodWill be merged/postponed/closed in ~10 calendar days unless new substational objections are raised.finished-final-comment-periodThe final comment period is finished for this RFC.needs-fcpThis change is insta-stable, so needs a completed FCP to proceed.S-waiting-on-teamStatus: Awaiting review/feedback/decision from relevant team(s)T-rustdocTeam: rustdoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

14 participants

@GuillaumeGomez@ehuss@fmease@lolbinarycat@rustbot@rfcbot@notriddle@Manishearth@apiraino@jyn514@aDotInTheVoid@camelid@jieyouxu@Mark-Simulacrum