|
| 1 | +#sparkfun.github.io |
| 2 | + |
| 3 | +This repo creates the GitHub pages custom domain`docs.sparkfun.com` and landing page that lists out all SparkFun GitHub product repos that have github pages documentation. |
| 4 | + |
| 5 | +The list of available pages is created automatically by a GitHub Action that runs nightly. This GitHub actions searches for repos under the spakfun organization that have the topic`sparkfun-tutorial`. |
| 6 | + |
| 7 | +For a repo to be added to the list of documents, the following should be true in the About section of the repo: |
| 8 | + |
| 9 | +* The repo has the topic`sparkfun-tutorial` |
| 10 | +* The`website` section for the repo points to the GitHub Pages URL for that repo (check the provided option when editing the about page). |
| 11 | +* The value of the description is provided |
| 12 | + |
| 13 | +###How this works |
| 14 | + |
| 15 | +* Daily, or on a check in, the update action runs |
| 16 | +* The Action using thg`gh` command to search for all public sparkfun respositories that have the topic`sparkfun-tutorial` |
| 17 | +* For each repositoriy found, the repo URL, About website and About description are retrieved |
| 18 | +* The results of the query are writting to the file`gsg.json` as an array of json objects. |
| 19 | +* The updated`gsg.json` file is checkin to this repo and the landing page is rebuilt (automtically by GitHub) |
| 20 | +* When the file`index.html` is loaded by a browser (for the landing page), it reads the file`gsg.json` and renders the documentation list table using javascript |
| 21 | + |
| 22 | + |