boost/website-v2
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2.git synced 2026-01-19 04:42:17 +00:00
Code Issues Projects Releases Wiki Activity

Addtitional Mailing List stats in release report (#1712)

Browse Source
This commit is contained in:
daveoconnor
2025-03-26 18:08:20 -07:00
committed by GitHub
parent ca56fc8e44
commit da6ee3524e
17 changed files with 545 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/commands.md
View File

@@ -320,3 +320,19 @@ For this to work `SLACK_BOT_API` must be set in the `.env` file.
| Options | Format | Description |
|----------------------|--------|--------------------------------------------------------------|
| `--user_id` | int | If passed, the user with this ID will receive email notifications when this task is started and finished, or if the task raises and exception. |
## `import_ml_counts`
**Purpose**: Import mailing list counts from the mailman archives.
```bash
./manage.py import_ml_counts
```
**Options**
| Options | Format | Description |
|----------------|--------|----------------------------------------------------------------------------------------------------------------------|
| `--start_date` | date | If passed, retrieves data from the start date supplied, d-m-y, default 20-11-1998 (the start of the data in mailman) |
| `--end_date` | date | If passed, If passed, retrieves data until the start date supplied, d-m-y, default today |

7
docs/development_setup_notes.md
View File

@@ -313,9 +313,9 @@ https://docs.allauth.org/en/latest/socialaccount/providers/google.html
1. `TF_VAR_google_cloud_email` (the email address of your Google Cloud account)
2. `TF_VAR_google_organization_domain` (usually the domain of your Google Cloud account, e.g. "boost.org" if you will be using an @boost.org email address)
3. `TF_VAR_google_cloud_project_name` (optional, default: localboostdev) - needs to change if destroyed and a setup is needed within 30 days
2. Run `make development-tofu-init` to initialize tofu.
3. Run `make development-tofu-plan` to confirm the planned changes.
4. Run `make development-tofu-apply` to apply the changes.
2. Run `just development-tofu-init` to initialize tofu.
3. Run `just development-tofu-plan` to confirm the planned changes.
4. Run `just development-tofu-apply` to apply the changes.
5. Go to https://console.developers.google.com/
1. Search for the newly created project, named "Boost Development" (ID: localboostdev by default).
2. Type "credentials" in the search input at the top of the page.
@@ -352,6 +352,7 @@ In your env:
#### Set Up Pycharm
You can set up your IDE with a new "Python Debug Server" configuration as:
<img src="images/pycharm_debugger_settings.png" alt="PyCharm Debugger Settings" width="400">
#### Common Usage

1
docs/first_time_data_import.md
View File

@@ -38,6 +38,7 @@ The `boost_setup` command will run all of the processes listed here:
# Get the most recent beta release, and delete old beta releases
./manage.py import_beta_release --delete-versions
./manage.py import_ml_counts
```
Read more aboout these [management commands](./commands.md).

12
docs/release_reports.md
View File

@@ -1,5 +1,17 @@
# Release Reports
## Prerequisites
1. You should upload updated subscriber data.
1. Ask Sam for a copy of the "subscribe" data.
2. In the Django admin interface go to "Subscription datas" under "MAILING_LIST".
3. At the top of the page click on the "IMPORT 'SUBSCRIBE' DATA" button.
2. To update the mailing list counts, if you haven't already run the "DO IT ALL" button:
1. Go to "Versions" under "VERSIONS" in the admin interface
2. At the top of the page click on the "DO IT ALL" button.
## Report Creation
1. Go to /admin
2. Go to the "Libraries" section
3. In the top menu click on "GET RELEASE REPORT".