Skip to content

Commit e126207

Browse files
authored
doc: Adds note about data.json and stars.json (#7)
1 parent 28b6122 commit e126207

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/contributing/fetching-data-from-github.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ Each Open Sauced user leverages their own GitHub repository as a database. The r
2424

2525
The repo [open-sauced/goals-template](https://github.com/open-sauced/goals-template) is used as a template repo to generate the user's `open-sauced-goals` repo.
2626

27+
**data.json**
28+
The Open Sauced goal data in this list is populatated using the [goals-caching.yml](https://github.com/open-sauced/actions/blob/main/goals-caching/update-open-sauced-goals-cache.js). Each opened issue in the goals repo full name is stored along with star, forks, and issues count. This is needed for rendering the user's open sauced dashboard.
29+
30+
**stars.json**
31+
The Open Sauced recommendation data is stored using the logged in user's starred repositories. This data is accessible via the GitHub API and stored publically in goals repo for easy rendering. The list is populatated using the [goals-caching.yml](https://github.com/open-sauced/actions/blob/main/goals-caching/update-open-sauced-goals-cache.js). _Plans are being developed to power platform wide recommendations using this data, this is pending the reviewing of the GitHub TOCs_.
32+
33+
2734
## Use of API in Components
2835

2936
The following table shows which components (`src/components/*.js`) use which API functions (`src/lib/apiGraphQL.js', 'src/lib/persistedGraphQL.js`), and what they do.

0 commit comments

Comments
 (0)