Clean up GitHub repository descriptions

[eecavanna]

Pros

• Easier for people to learn about unfamiliar repositories at a glance
• Easier for people to build a mental picture of our system at a glance
• Easier for people to find what they're looking for
• Looks cleaner and more intentional

Cons

• Takes time and energy to accomplish

Comments

• Who is our target audience(s)/reader(s)?

Examples

https://github.com/microbiomedata/nmdc-schema

- This repository contains the LinkML specification for the NMDC schema and the artifacts generated by LinkML.
+ Schema for the NMDC database (LinkML)

https://github.com/microbiomedata/nmdc-edge

- (Nothing)
+ Web app people can use to run bioinformatics workflows on NMDC infrastructure (React and Node/Express)

https://github.com/microbiomedata/nmdc-runtime

- runtime system for NMDC data management and orchestration
+ Core runtime and HTTP API for the NMDC database (FastAPI and Dagster)

https://github.com/microbiomedata/ReadbasedAnalysis

- (Nothing)
+ (Something)

Links

• HTTP API: https://api.github.com/orgs/microbiomedata/repos
• Web page: https://github.com/orgs/microbiomedata/repositories

Commands

Get a JSON array of all the current repository names and descriptions.

# Requires: https://github.com/jqlang/jq (on first download, may have to right-click > Open > Confirm, then `$ chmod +x` it)
curl 'https://api.github.com/orgs/microbiomedata/repos?page=1' | jq '[.[] | {name: .name, description: .description}]'
# Run for `?page=2` and `?page=3` also

[eecavanna]

Here's a PDF containing all the repository names and their current descriptions. The repositories are sorted by their updated_on date, as reported by GitHub. I don't know whether that means "last committed to" and/or "constituent Issue/PR last updated on".

NMDC GitHub Repository Descriptions (2024-01-25).pdf

[eecavanna]

People can refer to the NMDC Branding Notes document for some guidelines about describing parts of the NMDC system to certain audiences.