Metrics refresh (#500)

* add description, headings, and better titles

* black reformatting

* Update .github/workflows/write-metrics-md.py

Co-authored-by: Orhan Eroglu <[email protected]>

* Update .github/workflows/write-metrics-md.py

Co-authored-by: Orhan Eroglu <[email protected]>

* Update .github/workflows/write-metrics-md.py

---------

Co-authored-by: Orhan Eroglu <[email protected]>

Author: jukent

.github/workflows/get-metrics.py

@@ -258,7 +258,7 @@ def plot_usersXcountry(FOUNDATIONS_ID):
     # Plotting code
     fig = plt.figure(figsize=(10, 4))
     ax = plt.axes(projection=cartopy.crs.PlateCarree(), frameon=False)
-    ax.set_title('Pythia Foundations Users by Country', fontsize=15)
+    ax.set_title('All-Time Pythia Foundations Users by Country', fontsize=15)
 
     shapefile = cartopy.io.shapereader.natural_earth(category='cultural', resolution='110m', name='admin_0_countries')
     reader = cartopy.io.shapereader.Reader(shapefile)

.github/workflows/write-metrics-md.py

@@ -15,8 +15,17 @@ def process_user_data(json_file, top_pages, this_year, map, md_file):
         user_data.pop('Now')
         f.write('\n\n')
 
+        # Intro description
+        f.write(
+            'This metrics page provides an overview of user activity collected by Google Analytics across the three pillars of Project Pythia: our portal which includes information about the project as well as our resource gallery, our Foundations book, and our Cookbooks gallery. Information is either all-time (from a pre-project start date of March 2020) or year-to-date as indicated and is updated nightly to provide real-time and automated insights into our engagement, impact, and audience reach. If you would like to request a different metrics analysis, timeframe, or view, please [open a GitHub issue](https://github.com/ProjectPythia/projectpythia.github.io/issues/new/choose).\n\n'
+        )
+
         # Markdown table
-        headers = '| Project | Users |'
+        f.write('## Table of Total Active Users by Project\n\n')
+        f.write(
+            'This table displays the total active users of our 3 Pythia projects over the life of Project Pythia. Google analytics defines active users as the number of unique people who have visited the site and met certain [engagement requirements](https://support.google.com/analytics/answer/9234069?sjid=8697784525616937194-NC). You can read more from the [GA4 "Understand User Metrics" documentation](https://support.google.com/analytics/answer/12253918?hl=en).\n\n'
+        )
+        headers = '| Project | All-Time Users |'
         separator = '| ' + ' | '.join(['-----'] * 2) + ' |'
         rows = []
         for key in user_data.keys():
@@ -26,8 +35,22 @@ def process_user_data(json_file, top_pages, this_year, map, md_file):
         f.write('\n\n')
 
         # Add plots
+        f.write('## Chart of Active Users by Project Since Year Start\n\n')
+        f.write(
+            'This line plot displays active users for our 3 Pythia projects (Portal in purple, Foundations in blue, and Cookbooks in salmon) since January 1st of the current year.\n\n'
+        )
         f.write(f'![Users this Year]({this_year})\n\n')
+
+        f.write('## Chart of Top 5 Pages by Project\n\n')
+        f.write(
+            'This bar-chart displays the top 5 pages by project over the life of Project Pythia, as determined by screen page views. Screen page views refers to the number of times users viewed a page, including repeated visits. To learn more visit the [GA4 "API Dimensions & Metrics" page](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema).\n\n'
+        )
         f.write(f'![Top Pages]({top_pages})\n\n')
+
+        f.write('## Map of Total Foundation Active Users by Country\n\n')
+        f.write(
+            'This map displays the number of active users per country for Pythia Foundations for the entire life of Project Pythia.\n\n'
+        )
         f.write(f'![Users by Country]({map})\n\n')
 
     f.close()