Generalize reporting structure

Author: maxrjones

docs/adopting.md

@@ -14,6 +14,7 @@ nav:
   - PI Objectives: "objectives.md"
   - ODD Products: "products.md"
   - Tech Tips: "tech-tips.md"
+  - Adopting This Structure: "adopting.md"
 
 theme:
   language: en

mkdocs.yml

@@ -4,7 +4,7 @@
 
 1. Navigate to https://github.com/settings/personal-access-tokens/new
 2. Select public repositories
-3. Add new token as the environment variable `GH_ODD_PAT`
+3. Add new token as the environment variable specified by `TOKEN_ENV_VAR` in `settings.py` (default: `GH_ODD_PAT`)
 
 ## Configuration
 
@@ -29,7 +29,7 @@ This generates `objectives_config.py` with objectives and contributors from issu
 
 `TIME_RANGE` is automatically set to the current fiscal quarter (Q1: Oct-Dec, Q2: Jan-Mar, Q3: Apr-Jun, Q4: Jul-Sep).
 
-The generated chart colors bars by PI objective (see [objectives page](https://nasa-impact.github.io/veda-odd/objectives) for details).
+The generated chart colors bars by PI objective (see the objectives page on the deployed site for details).
 
 ### Regenerating docs/objectives.md
 

reports/README.md

@@ -302,7 +302,7 @@ def get_time_range(pi: str = None):
             ],
             "repos": [
                 ("zarr-developers", "virtualizarr"),
-                ("virtual-zarr", "obspec-utils"),
+                ("developmentseed", "obspec-utils"),
                 ("virtual-zarr", "virtual-tiff"),
                 ("virtual-zarr", "hrrr-parser"),
                 ("developmentseed", "async-tiff"),
@@ -426,7 +426,7 @@ def get_time_range(pi: str = None):
             "repos": [
                 ("zarr-developers", "virtualizarr"),
                 ("zarr-developers", "zarr-python"),
-                ("virtual-zarr", "obspec-utils"),
+                ("developmentseed", "obspec-utils"),
                 ("virtual-zarr", "virtual-tiff"),
                 ("virtual-zarr", "hrrr-parser"),
                 ("developmentseed", "virtualizarr-data-pipelines"),
@@ -445,7 +445,7 @@ def get_time_range(pi: str = None):
             ],
             "repos": [
                 ("zarr-developers", "virtualizarr"),
-                ("virtual-zarr", "obspec-utils"),
+                ("developmentseed", "obspec-utils"),
                 ("virtual-zarr", "virtual-tiff"),
                 ("developmentseed", "obstore"),
                 ("developmentseed", "obspec"),

reports/config.py

@@ -14,9 +14,10 @@
 import os
 import re
 from github import Github, Auth
+from settings import REPO_FULL_NAME, TOKEN_ENV_VAR
 
 
-def get_objective_issues(g: Github, repo_name: str = "NASA-IMPACT/veda-odd"):
+def get_objective_issues(g: Github, repo_name: str = REPO_FULL_NAME):
     """Fetch all issues with pi-*-objective labels using search API."""
     objectives_by_pi = {}
 
@@ -188,9 +189,9 @@ def generate_config(objectives_by_pi: dict) -> str:
 
 
 def main():
-    token = os.environ.get("GH_ODD_PAT") or os.environ.get("GITHUB_TOKEN")
+    token = os.environ.get(TOKEN_ENV_VAR) or os.environ.get("GITHUB_TOKEN")
     if not token:
-        raise ValueError("Set GH_ODD_PAT or GITHUB_TOKEN environment variable")
+        raise ValueError(f"Set {TOKEN_ENV_VAR} or GITHUB_TOKEN environment variable")
 
     auth = Auth.Token(token)
     g = Github(auth=auth)

reports/generate_config.py

@@ -7,6 +7,7 @@
 """
 
 from config import OBJECTIVES
+from settings import REPO_URL
 
 
 def generate_objectives_md() -> str:
@@ -46,7 +47,7 @@ def generate_objectives_md() -> str:
                 repos = ", ".join(r for _, r in obj["repos"]) if obj["repos"] else "-"
 
                 lines.append(
-                    f"| [#{num}](https://github.com/NASA-IMPACT/veda-odd/issues/{num}) | {title} | {contributors} | {repos} |"
+                    f"| [#{num}]({REPO_URL}/issues/{num}) | {title} | {contributors} | {repos} |"
                 )
 
             lines.append("")
@@ -75,7 +76,7 @@ def generate_objectives_md() -> str:
                 contributors = ", ".join(u for _, u in obj["contributors"])
 
                 lines.append(
-                    f"| [#{num}](https://github.com/NASA-IMPACT/veda-odd/issues/{num}) | {title} | {state} | {contributors} |"
+                    f"| [#{num}]({REPO_URL}/issues/{num}) | {title} | {state} | {contributors} |"
                 )
 
             lines.append("")
@@ -101,7 +102,7 @@ def generate_objectives_md() -> str:
     lines.append("## Configuration")
     lines.append("")
     lines.append(
-        "Objectives are configured in [`reports/config.py`](https://github.com/NASA-IMPACT/veda-odd/blob/main/reports/config.py)."
+        f"Objectives are configured in [`reports/config.py`]({REPO_URL}/blob/main/reports/config.py)."
     )
     lines.append("")
     lines.append("To regenerate this page from config:")

reports/generate_docs.py

@@ -15,6 +15,7 @@
     get_repos_for_pi,
     get_contributors_for_pi,
 )
+from settings import TOKEN_ENV_VAR
 
 
 def get_commits_for_repo_author(
@@ -153,5 +154,5 @@ def process_task(task):
 
 
 if __name__ == "__main__":
-    token = os.environ.get("GH_ODD_PAT") or os.environ.get("GITHUB_TOKEN")
+    token = os.environ.get(TOKEN_ENV_VAR) or os.environ.get("GITHUB_TOKEN")
     main(token=token)