Skip to content

Commit 3b9fba3

Browse files
ehussMark-Simulacrum
authored andcommitted
Specify maintenance and ownership of the forge.
1 parent 1910de7 commit 3b9fba3

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,13 @@ standard --fix js/
5252

5353
## Adding teams
5454

55-
Any Rust team can have a section in the Rust Forge. If you'd like to add your team, you first need to add them as an item to `src/SUMMARY.md`, like below, replacing `TEAM NAME` with your respective team's name to show on Forge, and `<TEAM_NAME>` with a filesystem- and URL-friendly version of that name where your documentation will be stored.
55+
Any Rust team, working group, or project group can have a section in the Rust Forge.
56+
First, please send a PR to add your team to the [`repos/rust-lang/rust-forge.toml`][team-repo] file to give your team permissions.
57+
58+
To add your team to the book, add it to [`src/SUMMARY.md`], like below, replacing `<TEAM_NAME>` with a filesystem- and URL-friendly version of your team's name:
5659

5760
```markdown
58-
- [TEAM NAME](src/<TEAM_NAME>/README.md)
59-
<!-- or -->
60-
- [TEAM NAME](src/<TEAM_NAME>.md)
61+
- [<TEAM NAME>](src/<TEAM_NAME>/README.md)
6162
```
6263

6364
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
@@ -67,3 +68,16 @@ It's recommended that you put general team information in `src/<TEAM_NAME>/READM
6768
```markdown
6869
- [TOPIC](src/<TEAM_NAME>/TOPIC.md)
6970
```
71+
72+
Teams are responsible for merging their own content.
73+
Please add your team to the `[assign.owners]` section of [`triagebot.toml`] so that the bot will auto-assign someone from the team.
74+
75+
[team-repo]: https://github.com/rust-lang/team/blob/master/repos/rust-lang/rust-forge.toml
76+
[`src/SUMMARY.md`]: https://github.com/rust-lang/rust-forge/blob/master/src/SUMMARY.md
77+
[`triagebot.toml`]: https://github.com/rust-lang/rust-forge/blob/master/triagebot.toml
78+
79+
## Maintenance of Rust Forge
80+
81+
The [Rust infra team] is responsible for maintaining the Rust Forge, ensuring that its build and publish system works, and coordinating any technical issues with teams.
82+
83+
[Rust infra team]: https://www.rust-lang.org/governance/teams/infra

0 commit comments

Comments
 (0)