Skip to content

Commit b4580b4

Browse files
committed
document overall setup
1 parent 45a1fac commit b4580b4

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,6 @@
2929

3030
# 🔧 Running the goals program
3131

32+
* [Overall setup](./admin/setup.md)
3233
* [Mdbook plugin details](./admin/mdbook_plugin.md)
3334
* [Commands you can run](./admin/commands.md)

src/admin/setup.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Overall setup
2+
3+
The rust-project-goals repository is set up as follows
4+
5+
* an mdbook for generating the main content
6+
* a Rust binary in `src` that serves as
7+
* a runnable utility for doing various admin functions on the CLI (e.g., generating a draft RFC)
8+
* an mdbook preprocessor for generating content like the list of goals
9+
* a utility invoked in CI that can query github and produce a JSON with the goal status
10+
* pages on the Rust website that fetches JSON data from rust-project-goals repo to generate content
11+
* the JSON data is generated by the Rust binary
12+
* tracking issues for each active project goal:
13+
* tagged with `C-tracking-issue`
14+
* and added to the appropriate milestone
15+
* triagebot modifications to link Zulip and the repo tracking issues
16+
* the command `@triagebot ping-goals N D` will ping all active goal owners to ask them to add updates
17+
* *N* is a threshold number of days; if people have posted an update within the last N days, we won't bother them. Usually I do this as the current date + 7, so that people who posted during the current month or the last week of the previous month don't get any pings.
18+
* *D* is a word like `Sep-22` that indicates the day
19+
* the bot monitors for comments on github and forwards them to Zulip
20+

0 commit comments

Comments
 (0)