Merge pull request #7 from SpareCores/DEV-4

document all tables and columns

.github/workflows/dbdocs.yaml

@@ -21,6 +21,8 @@ jobs:
         run: sc-crawler schema mysql > schema.sql
       - name: Convert SQL schema to DBML
         run: sql2dbml --mysql schema.sql -o schema.dbml
+      - name: Add project description
+        run: cat project.dbml >> schema.dbml
       - name: Update dbdocs project
         env:
           DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}

project.dbml

@@ -0,0 +1,11 @@
+Project DBML {
+  Note: '''
+    # Spare Cores (SC) Crawler database schemas
+
+    [Spare Cores](https://sparecores.com), a Python-based open-source ecosystem, provides a comprehensive and standardized inventory, along with performance evaluations of available compute resources across public cloud and server providers. The project providers different components to interact with the database schemas defined here:
+
+    * Run the SC Crawler, to compile your own database: https://github.com/SpareCores/sc-crawler
+    * Use the SC Data package to easily grab a copy of the database: https://github.com/SpareCores/sc-data
+    * Fire up an API using the SC Keeper package on the top of the database: https://github.com/SpareCores/sc-keeper
+  '''
+}