Add further helper scripts and docs - #3
Open
adamjtaylor wants to merge 8 commits into
Open
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdto 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:
README.mdto 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:
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.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:
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.