update prose and structure for monthly reporting script (#1000)

Co-authored-by: wamirez <wamirez@protonmail.com>

maintainers/this-month-in-nix-docs/README.md

@@ -1,15 +1,17 @@
-# This month in Nix docs
+# This month in Nix documentation
-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.
 
-A new post is created via:
+This is a script and template for compiling "This month in Nix documentation".
-```
+The process is semi-automated:
-$ ./make-post.sh <from YYYY-MM-DD> <to YYYY-MM-DD> > new-post.md
+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.
-```
 
-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.
+Create a new report with:
+
+```
+$ ./make-post.sh <from YYYY-MM-DD> <to YYYY-MM-DD> > report.md
+```
 
 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.
 

maintainers/this-month-in-nix-docs/make-post.sh

@@ -41,58 +41,62 @@ list_opened_prs() {
 # Lists all of the tracking issues opened on nix.dev within the specified dates
 list_new_tracking_issues() {
     gh issue list -R "nixos/nix.dev" --search "created:$from_date..$to_date label:tracking" --json "$pr_fields" --template "$tracking_issue_template"
+    gh issue list -R "nixos/nixpkgs" --search "created:$from_date..$to_date label:\"6.topic: documentation\" tracking" --json "$pr_fields" --template "$tracking_issue_template"
 }
 
 cat << EOF
-# This Month in Nix Docs - #NUMBER - MONTH YEAR
+# This month in Nix documentation - #ISSUE - MONTH YEAR
 
-## Community
+## News
-The Documentation Team can be found in a number of places. Check the [Documentation Team page](https://nixos.org/community/teams/documentation.html) and drop in if you'd like to contribute!
 
-## Projects
+<!-- write down some highlights here -->
+
+## Get in touch
+
+Check the [Nix documentation team page](https://nixos.org/community/teams/documentation.html) for information on how to get in touch. Write us or drop into the office hours if you'd like to get things done together!
+
+## How you can help
 
-## How You Can Help
 If you like what we're doing, consider [joining the documentation team](https://nixos.org/community/teams/documentation) or [donating to the NixOS Foundation's documentation project on Open Collective](https://opencollective.com/nixos/projects/documentation-project) to fund ongoing maintenance and development of learning materials and other documentation.
 
-## RFCs
+## Recent changes
 
-## Documentation PRs Merged
+This is a list of all recent changes made to documentation in the Nix ecosystem.
-
-# AUTOGENERATED
 
 EOF
 
-echo "## PRs"
-echo
-
 echo "### NixOS/nix"
+echo
 list_merged_prs "nixos/nix" "documentation"
 echo
 
 echo "### NixOS/nixpkgs"
+echo
 list_merged_prs "nixos/nixpkgs" "6.topic: documentation"
 list_merged_prs "nixos/nixpkgs" "8.has: documentation"
 echo
 
 echo "### NixOS/nix-pills"
+echo
 list_merged_prs "nixos/nix-pills"
 echo
 
 echo "### NixOS/nix.dev"
+echo
 list_merged_prs "nixos/nix.dev"
 echo
 
-echo "## RFCs"
+echo "### New tracking issues"
+echo
+list_new_tracking_issues
 echo
 
-echo "### Opened (manually check for relevance)"
+echo "## Opened RFCs"
+echo "<!-- manually check for relevance -->"
 list_opened_prs "nixos/rfcs"
 echo
 
-echo "### Accepted (manually check for relevance)"
+echo "## Accepted RFCs"
+echo "<!-- manually check for relevance -->"
 list_merged_prs "nixos/rfcs"
 echo
-
-echo "## New Tracking Issues"
-list_new_tracking_issues
-echo