Skip to content

Commit 1f53085

Browse files
committed
expand and fix cargo rpg updates documentation
1 parent 5675797 commit 1f53085

File tree

2 files changed

+12
-20
lines changed

2 files changed

+12
-20
lines changed

src/admin/author_updates.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,12 @@ Triagebot can ping project-goal owners for updates. To use it, go to Zulip and e
88
@triagebot ping-goals 14 Oct-21
99
```
1010

11-
The first number (14) is a threshold, it is typically set to the current day of the month (e.g., the above command assumes it is Oct 14). It means "if they have posted a comment in the last 14 days, don't bug them".
11+
The first number (14) is a threshold, it is typically set to the current day of the month (e.g., the above command assumes it is Oct 14). It means "if they have posted a comment in the last 14 days, don't bug them".
1212

1313
The second string ("Oct-21") is the deadline for updates to be included.
1414

1515
We need to improve this UI.
1616

1717
## Filling out the template
1818

19-
Run the `cargo rpg updates` command to create the blog post template. If running from within vscode, the `--vscode` command will open the result in a fresh tab, which is convenient. Otherwise, use `--output-file $file.md` to create a new file.
20-
21-
The template will be filled in with the list of flagship goals. Each flagship goal will have their [Why this goal?](./merge_rfc.md#author-the-why-this-goal-sections-for-the-flagship-goals) section auto-inserted from the corresponding tracking issue.
22-
23-
The template will also include the detailed list of updates in a `<details>` section as well as any TL;DR comments left by users.
24-
25-
The update template itself is maintained with handlebars, you will find it [here](https://github.com/rust-lang/rust-project-goals/blob/main/templates/updates.hbs).
26-
27-
28-
19+
After the updates have been published, they can be summarized in a monthly blog post, as described in [this dedicated chapter](./updates.md).

src/admin/updates.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@ Usage:
66
> cargo rpg updates --help
77
```
88

9-
The `updates` command generates the starting point for a monthly blog post. The output is based on the handlebars templates found in the `templates` directory. The command you probably want most often is something like this
9+
Run the `cargo rpg updates` command to create the blog post template. If running from within vscode, the `--vscode` command will open the result in a fresh tab, which is convenient. Otherwise, use `--output-file $file.md` to create a new file.
1010

11-
```
12-
> cargo rpg updates YYYYhN --vscode
13-
```
11+
The template will be filled in with the list of flagship goals. Each flagship goal will have their [Why this goal?](./merge_rfc.md#author-the-why-this-goal-sections-for-the-flagship-goals) section auto-inserted from the corresponding tracking issue.
12+
13+
The template will also include the detailed list of updates in a `<details>` section as well as any TL;DR comments left by users.
1414

15-
which will open the blogpost in a tab in VSCode. This makes it easy to copy-and-paste over to the main Rust blog.
15+
The update template itself is maintained with handlebars, you will find it [here](https://github.com/rust-lang/rust-project-goals/blob/main/templates/updates.hbs).
1616

17-
## Blog post starting point
1817

19-
The blog post starting point is based on the handlebars template in `templates/updates.hbs`.
18+
This command can also take optional dates to control which comments and updates in the given date range are included in the blog post. This is usually needed to correctly set the starting date right after the previous month's blog post.
2019

21-
## Configuring the LLM
20+
For example,
2221

23-
The `updates` command makes use of an LLM hosted on AWS Bedrock to summarize people's comments. You will need to run `aws configure` and login with some default credentials. You can skip the LLM by providing the `--quick` command-line option, but then you have to generate your own text, which can be pretty tedious.
22+
```
23+
> cargo rpg updates 2025h1 2025-03-01
24+
```

0 commit comments

Comments
 (0)