Skip to content

Conversation

@adamjtaylor
Copy link
Contributor

This pull request significantly improves the documentation and automation scripts for HTAN2 project setup and management. The most important changes include a comprehensive overhaul of the README.md to document all scripts, the addition of robust new automation scripts for project annotation and team admin management, and the introduction of a detailed project metadata YAML file. These updates streamline the workflow for project creation, team management, annotation, and user onboarding in Synapse and Jira.

Documentation Improvements:

  • Expanded and restructured README.md to provide a detailed overview of all automation scripts, their features, usage instructions, configuration details, workflow steps, troubleshooting, and security notes. This makes it much easier for new users to understand and use the repository. [1] [2]

Automation Scripts:

  • Added add_project_annotations.py, a script that validates and applies standardized schema.org-compliant annotations to Synapse projects using metadata from a YAML file, with robust error handling and logging.
  • Introduced add_team_admin.py, which automates inviting a user (by Synapse user ID) to all HTAN2 teams and promotes them to admin, including checks for membership and error handling.

Configuration and Metadata:

  • Added project_details.yml, a comprehensive YAML file listing all HTAN2 projects with their Synapse IDs, grant numbers, centers, shortnames, and grant names, to be used by automation scripts for consistent metadata application.

adamjtaylor and others added 8 commits October 15, 2025 12:17
…and update email generation logic for community team members
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Added validation for required project fields and improved error handling during project processing.
Add error handling for Synapse login process.
…eck_airtable_synapse_users.py and test_email.txt files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants