Merge branch 'master' into libs/more-docs

Author: KodrAus

blacksmith/Cargo.lock

@@ -21,6 +21,6 @@ version = "2.33.1"
 default-features = false
 
 [dependencies.mdbook]
-version = "=0.4.0"
+version = "=0.4.1"
 default-features = false
 features = ["search"]

blacksmith/Cargo.toml

@@ -40,3 +40,9 @@ git-repository-url="https://github.com/rust-lang/rust-forge"
 "compiler/bug-fix-procedure.html" = "https://rustc-dev-guide.rust-lang.org/bug-fix-procedure.html"
 "compiler/diagnostic-codes.html" = "https://rustc-dev-guide.rust-lang.org/diagnostics/diagnostic-codes.html"
 "compiler/profile-queries.html" = "https://rustc-dev-guide.rust-lang.org/queries/profiling.html"
+"chat/index.html" = "/platforms/index.html"
+"chat/discord.html" = "platforms/discord.html"
+"github.html" = "platforms/github.html"
+"chat/email.html" = "platforms/email.html"
+"chat/zulip/index.html" = "platforms/zulip/index.html"
+"chat/zulip.html" = "platforms/zulip.html"

book.toml

@@ -1,11 +1,13 @@
 # Rust Forge
 
 [Overview](./README.md)
-- [Chat Platforms](./chat/README.md)
-  - [Discord](./chat/discord.md)
-  - [Email](./chat/email.md)
-  - [Zulip](./chat/zulip.md)
-      - [Moderation](./chat/zulip/moderation.md)
+- [Platforms](./platforms/README.md)
+  - [Discord](./platforms/discord.md)
+  - [Email](./platforms/email.md)
+  - [GitHub](./platforms/github.md)
+  - [Zulip](./platforms/zulip.md)
+      - [Moderation](./platforms/zulip/moderation.md)
+      - [Triagebot](./platforms/zulip/triagebot.md)
 - [Core](./core/README.md)
     - [Rust Blog Guidelines](./core/blogs.md)
     - [Legal counsel](./core/legal.md)
@@ -18,6 +20,9 @@
     - [So you want to add a new option to rustc?](./compiler/new_option.md)
     - [Major Change Proposals](./compiler/mcp.md)
     - [Membership](./compiler/membership.md)
+    - [Prioritization](./compiler/prioritization.md)
+      - [Procedure](./compiler/prioritization/procedure.md)
+    - [Notification groups](./compiler/notification-groups.md)
     - [Triage Meeting](./compiler/triage-meeting.md)
     - [Steering Meeting](./compiler/steering-meeting.md)
         - [Submitting a proposal](./compiler/steering-meeting/submit.md)
@@ -31,7 +36,6 @@
   - [Self-hosting a docs.rs instance](./docs-rs/self-hosting.md)
   - [Maintenance procedures](./docs-rs/maintenance.md)
   - [Migrating from a local database to S3](./docs-rs/migrate-s3.md)
-- [GitHub](./github.md)
 - [Governance](./governance/README.md)
 - [Infrastructure](./infra/README.md)
     - [Other Installation Methods](./infra/other-installation-methods.md)

src/SUMMARY.md

@@ -0,0 +1,39 @@
+# Notification groups
+
+The compiler team has a number of notification groups that we use to
+ping people and draw their attention to issues. Notification groups
+are setup so that anyone can join them if they want.
+
+## Creating a notification group
+
+If you'd like to create a notification group, here are the steps.
+First, you want to get approval from the compiler team:
+
+* Propose the group by preparing a [Major Change Proposal][MCP].  If
+  your group is not analogous to some existing group, it is probably
+  a good idea to ping compiler team leads before-hand or as part of
+  the MCP.
+* The MCP should specify what GitHub label will be associated with the
+  notification group. Often this is an existing label, such as
+  `O-Windows`.
+  
+Once the MCP is accepted, here are the steps to actually create the group.
+In some cases we include an example PR from some other group. 
+
+* File a tracking issue in the rust-lang/compiler-team repository to collect
+  your progress.
+* Create a PR against the rust-lang/team repository adding the notification
+  group. [Example PR.](https://github.com/rust-lang/team/pull/347)
+* Configure the rust-lang/rust repository to accept triagebot commands
+  for this group. [Example PR.](https://github.com/rust-lang/rust/pull/72706)
+* Create a PR for the rustc-dev-guide amending [the notification group
+  section](https://rustc-dev-guide.rust-lang.org/notification-groups/about.html)
+  to mention your group.
+* Create a sample PR for the rust-lang/team repository showing how one can add
+  oneself. This will be referenced by your blog post to show people how to 
+  join. [Example PR.](https://github.com/rust-lang/team/pull/140)
+* Write an announcement blog post for Inside Rust and open a PR against
+  [blog.rust-lang.org](https://github.com/rust-lang/blog.rust-lang.org).
+  [Example PR.](https://github.com/rust-lang/blog.rust-lang.org/pull/615)
+
+[MCP]: ./mcp.md

src/chat/README.md

@@ -0,0 +1,3 @@
+# Prioritization
+
+This section documents the processes of the prioritization WG.

src/compiler/notification-groups.md

@@ -0,0 +1,218 @@
+# Prioritization WG - Procedure
+
+This document details the procedure the WG-prioritization follows to fill the agenda for the weekly meeting of `T-compiler`.
+The working group focuses mainly on triaging `T-compiler` and `libs-impl` bugs, deciding if bugs are critical (potential release blockers) or not and building the agenda for the most important things `T-compiler` needs to discuss.
+
+## The procedure in detail
+
+High level overview:
+
+- [Follow ups from previous meeting](#Follow-ups-from-previous-meeting)
+  - Remove `I-nominated` tags of already discussed issues
+  - Notify @pnkfelix about not properly tagged stable/beta-nominated issues
+  - Create the next meeting agenda using the weekly agenda template
+- [Prepare agenda content](#Prepare-agenda-content)
+  - Add `T-compiler` and `libs-impl` to unlabelled T-compiler and libs-impl issues
+  - Assign priority to unprioritized issues with "I-prioritize" label
+  - Assign priority to regressions without a `P-*` label
+  - Summarize stable/beta nominations
+  - Summarize PR's waiting on team
+  - Summarize `P-critical` and unassigned `P-high` regressions
+  - Summarize I-nominated issues
+  - Process MCPs/FCPs
+- [Generate Agenda](#Generate-Agenda)
+  - Run cli to generate agenda
+  - Fill agenda announcements
+  - Add performance logs
+- [Notify the team about the meeting](#Notify-the-team-about-the-meeting)
+  - Figure out which WGs need to check-in
+  - Notify @T-compiler/meeting about the meeting on Zulip
+- [Final reviews](#Final-reviews)
+  - Check toolstate
+  - Check performance stats
+  - Nominate issues
+  - Re-sync and check the agenda right before the meeting
+
+## General review process
+
+- Check the status of the issue
+- Try moving it forward if possible (ex. stimulate further comments from the issue author or a reviewer)
+- Ask for more info if it's needed
+- Is there an MCVE for the issue already?
+- Check if it's a regression and label it accordingly (`regression-*` labels)
+- Figure out the area the issue belongs and label it accordingly (`A-*` labels)
+- [Ping notify groups](https://rustc-dev-guide.rust-lang.org/notification-groups/about.html) or relevant teams
+- Assign if possible
+- Nominate the issue if it needs to be discussed
+
+## Follow ups from previous meeting
+
+- Remove `I-nominated` tags of already discussed issues
+- Notify @pnkfelix about accepted `beta-nominated` and `stable-nominated` without `beta-accepted` and `stable-accepted` label
+- Notify @pnkfelix about rejected `beta-nominated` and `stable-nominated` still with the nominated label
+- Create an empty agenda using our template, as soon as our Thursday's weekly meeting ends
+
+## Prepare agenda content
+
+### Add `T-compiler` and `libs-impl` labels
+
+Add `T-compiler` and `libs-impl` labels to corresponding issues that are missing these labels.
+
+- [All unprioritized I-prioritize](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+-label%3AP-critical+-label%3AP-high+-label%3AP-medium+-label%3AP-low+label%3AI-prioritize)
+- [All stable nominations](https://github.com/rust-lang/rust/issues?q=is%3Aall+label%3Astable-nominated+-label%3Astable-accepted)
+- [All beta nominations](https://github.com/rust-lang/rust/issues?q=is%3Aall+label%3Abeta-nominated+-label%3Abeta-accepted)
+- [All I-nominated](https://github.com/rust-lang/rust/labels/I-nominated)
+- [All PR's waiting on team](https://github.com/rust-lang/rust/labels/S-waiting-on-team)
+
+### Assign priority to unprioritized issues with "I-prioritize" label
+
+We need all `I-prioritize` issues for `T-compiler` and `libs-impl` to be actually prioritized. To do so, we add one of the `P-critical`, `P-high`, `P-medium` or `P-low` labels and remove `I-prioritize` and also add a text such as:
+
+> Assigning `P-XXX` as [discussed as part of the Prioritization Working Group procedure](link_to_zulip_conversation) and removing `I-prioritize`.
+
+The procedure here follows the [General review process](#General-review-process).
+
+Note: triagebot automatically creates a topic and notify @*WG-prioritization* members once an issue is labelled with `I-prioritize`
+Note #2: These lists should typically be empty when we are close to the meeting.
+
+### Assign priority to regressions without a P-label
+
+We should not have unprioritized regressions and ideally regressions should have an assignee.
+
+The procedure here follows the [General review process](#General-review-process).
+
+Note: triagebot automatically adds `I-prioritize` to all regression issues and creates a topic and notify @*WG-prioritization* members requesting prioritization.
+
+### Summarize stable/beta nominations
+
+- Add them to the agenda explaining:
+  - Why was it nominated
+  - Who the assignee is
+  - Add important details
+
+Note: triagebot automatically creates a topic and notify @*WG-prioritization* members requesting addition to the agenda.
+
+### Summarize PR's waiting on team
+
+These are PRs waiting for some decision by our team (`T-compiler` or `libs-impl`).
+
+The procedure here should try following the [General review process](#General-review-process).
+
+We should:
+
+- Add them to the agenda explaining:
+  - What are they waiting for
+  - Add important details
+- Explicitly nominate any issue that can be *quickly* resolved in a triage meeting.
+
+Note: triagebot automatically creates a topic and notify @*WG-prioritization* members requesting addition to the agenda.
+
+### Summarize `P-critical` and unassigned `P-high` regressions
+
+The procedure here should try following the [General review process](#General-review-process).
+
+We should:
+
+- [Notify the appropriate groups](https://rustc-dev-guide.rust-lang.org/notification-groups/about.html)
+- Push them forward, if possible
+- Assign if possible; if the issue remains unassigned, it should be added to the agenda so we can assign it during the meeting
+
+Note: triagebot automatically creates a topic and notify @*WG-prioritization* members requesting addition to the agenda.
+
+### Summarize I-nominated issues
+
+Issues labeled with `I-nominated` are important issues that we decide deserve discussion during the weekly meeting.
+
+The procedure here should try following the [General review process](#General-review-process).
+
+We should:
+
+- Check if these issues were already discussed and in that case remove `I-nominated` label
+- Check if each issue is worth being discussed
+- Add them to the agenda explaining:
+  - Why was it nominated
+  - Who the assignee is
+  - Is this an issue or a PR: if an issue, does it have a PR that fixes it?
+  - Add important details
+
+Note: triagebot automatically creates a topic and notify @*WG-prioritization* members requesting addition to the agenda.
+
+### Accept MCPs
+
+Accept all [MCPs that have been on `final-comment-period`](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aopen+label%3Amajor-change) for 10 or more days. Basically check that `final-comment-period` label was added more than 10 days ago.
+To accept, remove `final-comment-period`, add `major-change-accepted` and close the issue.
+
+## Generate Agenda
+
+### Run cli to generate agenda
+
+Run triagebot's prioritization cli to generate the agenda.
+For that you need to clone https://github.com/rust-lang/triagebot if you haven't done so already.
+You need to export your `GITHUB_API_TOKEN` on Linux that's typically done by adding
+
+`export GITHUB_API_TOKEN=<your key>`
+
+to your `~/.profile` file.
+
+And then run:
+
+```
+$ cargo run --bin prioritization
+```
+
+### Remove `to-announce` from MCPs/FCPs
+
+As a quick reminder:
+
+MCP = Major Change Proposal
+FCP = Final Comment Period
+
+Remove all [`to-announce` MCPs](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aall+label%3Amajor-change+label%3Ato-announce) as they were already added in the agenda in their corresponding place.
+
+FIXME: We need to add `to-announce` also to FCPs and here we would need to also remove the [FCPs `to-announce`](https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aall+label%3Afinished-final-comment-period+label%3Ato-announce)
+
+### Fill agenda announcements
+
+Check the compiler calendar to see if there's an outstanding event to announce and add it to the agenda.
+
+### Add performance logs
+
+- Add Triage Logs to the agenda
+  - https://github.com/rust-lang/rustc-perf/tree/master/triage#triage-logs
+
+## Notify the team about the meeting
+
+Create `[weekly meeting] YYYY-MM-DD #54818` topic in `#t-compiler/meetings` Zulip's stream and send the following messages:
+
+```text
+Hi @*T-compiler/meeting*; the triage meeting will be starting in ~ X hours Y minutes
+The @*WG-prioritization* have done pre-triage in #**t-compiler/wg-prioritization**
+@*WG-prioritization* have prepared the [meeting agenda](link_to_hackmd_agenda)
+We will have checkins from @*WG-X* and @*WG-Y*
+@**person1** do you have something you want to share about @*WG-X*?
+@**person2** do you have something you want to share about @*WG-Y*?
+```
+
+Note: [Check which working groups' check-ins follow](https://rust-lang.github.io/compiler-team/about/triage-meeting/)
+
+## Final reviews
+
+### Check toolstate
+
+Check [toolstate](https://rust-lang-nursery.github.io/rust-toolstate/) for tool breakage and notify teams in the corresponding channels.
+
+### Check performance stats
+
+Check [perf regressions](http://perf.rust-lang.org/index.html) and notify involved actors.
+
+### Nominate P-high issues
+
+Check how packed the agenda looks like and if there's room for more nominations.
+
+- [Other team's P-critical](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AP-critical+-label%3AT-compiler+-label%3Alibs-impl)
+- [T-compiler P-high](https://github.com/rust-lang/rust/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3AT-compiler+label%3AP-high+)
+- [libs-impl P-high](https://github.com/rust-lang/rust/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Alibs-impl+label%3AP-high+)
+
+### Re-sync and check the agenda right before the meeting
+
+Re-run the script and re-synchronize contents of the agenda with new information.

src/compiler/prioritization.md

@@ -3,7 +3,7 @@
 - [Which installer should you use?](#which)
 - [Other ways to install `rustup`](#more-rustup)
 - [Standalone installers](#standalone)
-- [Source code](#source)
+- [Source code](#source-code)
 
 ## Which installer should you use?
 

src/compiler/prioritization/procedure.md

@@ -5,6 +5,7 @@ This section documents meta processes by the Libs team.
 ## Where to find us
 
 The libs team hangs out primarily in [the rust-lang Zulip](https://rust-lang.zulipchat.com/) these days in the `#t-libs` stream.
+
 You can also find out more details about [Zulip and how the Rust community uses it](../../chat/zulip.html).
 
 ## Useful GitHub queries

src/infra/other-installation-methods.md

@@ -0,0 +1,5 @@
+## Platforms
+
+Rust uses a number of different platforms for organizing work and internal communications between
+teams. This does not currently seek to be an exhaustive list, rather documenting
+the policies for a select few platforms used by the teams.