Skip to content

Commit b56edc3

Browse files
committed
clarify data source and update formatting
1 parent d2060d9 commit b56edc3

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

sync_community_team/README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
11
# Push Data to CCOS
22

3-
This folder contains a script that automatically creates GitHub teams and updates their membership based on the Community Team Tracker board on Asana. It uses underlying data from the [Community Team Members page on CC Open Source][ctlistpage] to generate and populate these teams.
3+
This folder contains a script (`sync_teams.py`) that automatically:
4+
1. creates GitHub teams
5+
2. updates their membership based on the
6+
[`community_team_members.json`][databag] databag
7+
- The databag is used to create the [Community Team Members — Creative
8+
Commons Open Source][ctlistpage] page
9+
- The databag is populated from the Community Team Tracker board on Asana by
10+
[`../push_data_to_ccos/`](../push_data_to_ccos/)
411

5-
[ctlistpage]: httpe://opensource.creativecommons.org/community/community-teams/members/
12+
[databag]: https://github.com/creativecommons/creativecommons.github.io-source/blob/master/databags/community_team_members.json
13+
[ctlistpage]: https://opensource.creativecommons.org/community/community-team/members/
614

7-
This script is run via GitHub Actions automatically.
15+
This script is run via GitHub Actions automatically.
816

917
## Running the Script
1018

1119
1. Install [Pipenv](https://pipenv.readthedocs.io/en/latest/)
1220
2. Navigate to the `sync_community_team` folder and run `pipenv install`
13-
3. Set the `ADMIN_GITHUB_TOKEN` environment variable with your GitHub token. You will need a GitHub token with admin permissions to the `creativecommons` GitHub organization.
14-
5. Run the script: `pipenv run sync_teams.py` (or if you're in a virtual environment already, `python3 sync_teams.py`)
21+
3. Set the `ADMIN_GITHUB_TOKEN` environment variable with your GitHub token.
22+
You will need a GitHub token with admin permissions to the `creativecommons`
23+
GitHub organization.
24+
5. Run the script: `pipenv run sync_teams.py` (or if you're in a virtual
25+
environment already, `python3 sync_teams.py`)
1526

1627
## About the Code
1728

0 commit comments

Comments
 (0)