-
-
Notifications
You must be signed in to change notification settings - Fork 239
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update prose and structure for monthly reporting script (#1000)
Co-authored-by: wamirez <wamirez@protonmail.com>
- Loading branch information
1 parent
7833057
commit 6cdcc8d
Showing
2 changed files
with
33 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,17 @@ | ||
# This month in Nix docs | ||
This is a script and template for compiling "This Month in Nix Docs". The process is semi-automated. The script queries a collection of Nix repositories, looking for merged PRs with documentation-related labels, RFCs (you have to look through these manually), and tracking issues in this repository. | ||
# This month in Nix documentation | ||
|
||
This is a script and template for compiling "This month in Nix documentation". | ||
The process is semi-automated: | ||
The script queries a collection of Nix repositories, looking for merged PRs with documentation-related labels, RFCs (you have to look through these manually), and tracking issues in this repository. | ||
|
||
Create a new report with: | ||
|
||
A new post is created via: | ||
``` | ||
$ ./make-post.sh <from YYYY-MM-DD> <to YYYY-MM-DD> > new-post.md | ||
$ ./make-post.sh <from YYYY-MM-DD> <to YYYY-MM-DD> > report.md | ||
``` | ||
|
||
After this invocation a template post (`new-post.md`) will be filled out with the GitHub query results formatted as markdown at the end of the file. | ||
|
||
There is some post-processing required: | ||
- Fill in the number and year/month at the top of the post. | ||
- Fill in the issue number and year/month at the top of the post. | ||
- Manually check the RFCs for relevance | ||
- Remove the "Tracking Issues" section, it's there for your convenience while writing. | ||
- Remove the "Tracking issues" section, it's there for your convenience while writing. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters