--select tag:mart (#132)

Author: allison-code-dot-org

.github/hide_docs.py

@@ -0,0 +1,21 @@
+import json
+
+# modify manifest.json in dbt/target/ to hide things
+
+with open('dbt/target/manifest.json', 'r') as f:
+  data = json.loads(f.read())
+
+for macro in data['macros']:
+  data['macros'][macro]['docs']['show'] = False
+
+for node in data['nodes']:
+  if 'model.redshift' in node:
+    data['nodes'][node]['docs']['show'] = False
+
+  if 'model.cdo_analytics' in node:
+    config = data['nodes'][node]['config']
+    if not config or 'released' not in config['tags']:
+      data['nodes'][node]['docs']['show'] = False
+
+with open('dbt/target/manifest.json', 'w') as f:
+  json.dump(data, f)

.github/workflows/generate_docs.yml

@@ -47,6 +47,9 @@ jobs:
         working-directory: ./dbt
         run: dbt docs generate
 
+      - name: Hide unnecessary parts of docs
+        run: python .github/hide_docs.py
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

dbt/dbt_project.yml

@@ -68,6 +68,8 @@ models:
       tags:
         - "int"
       +materialized: table
+      +docs:
+        show: false
 
     marts: 
       tags:
@@ -78,6 +80,8 @@ models:
       tags:
         - "staging"
       +materialized: view
+      +docs:
+        show: false
 
       dashboard:
         base: 
@@ -104,9 +108,16 @@ models:
           tags:
             - "base"
           materialized: ephemeral
+        +docs:
+          show: false
 
       amplitude:
         base: 
           tags:
             - "base"
-          materialized: ephemeral
+          materialized: ephemeral
+
+seeds:
+  +docs:
+    show: false
+

dbt/macros/_macros.yml

@@ -4,13 +4,19 @@ macros:
   - name: active_status_label
     description: >
       This macro is an attempt to engage in some DRY practice - to remove repeticious hard-coded labels for school, teacher, etc. activity. We have a method for determining whether a school, teacher, section is "active" (see: dim_school_status.) The method produces a 3-digit binary code. The key is below. This method is used in several locations where a label e.g. "active new" is applided. These 3 values can be combined into an ordered 3-char string representing the concatenated true/false combinations for Active|Prev|Ever. (e.g. "101" means the schools is 1. Active, 2. Was not active last year) therefore, we label it as "Active - Reacquired."
+    docs:
+      show: false
 
   - name: pad_school_id
     description: >
       This macro adjusts for known data quality issue where a `school_id` can be 11 or 12 characters in length.
+    docs:
+      show: false
 
   - name: us_intl_label
     description: Quick and handy way to convert is_international to a reporting label.
+    docs:
+      show: false
 
 
 # template from chatgpt
@@ -30,4 +36,4 @@ macros:
 #       - name: Example Usage
 #         description: A brief description of the example.
 #         code: |
-#           {{ macro_name(argument='value') }}
+#           {{ macro_name(argument='value') }}

dbt/models/marts/courses/_courses__models.yml

@@ -15,6 +15,8 @@ models:
     #     tests:
     #       - unique
     #       - not_null
+    config:
+      tags: ['released']
 
 
   - name: dim_levels
@@ -48,4 +50,4 @@ models:
         description: bit field does this level have a mapping for concept-difficulty
 
       - name: course_family
-        description: the short name for which course this script/level combo belongs to e.g. csf, csd, csp, csa, hoc, etc.
+        description: the short name for which course this script/level combo belongs to e.g. csf, csd, csp, csa, hoc, etc.

dbt/models/staging/pegasus_pii/_pegasus_pii__sources.yml

@@ -7,4 +7,4 @@ sources:
     tables:
       - name: forms
       - name: form_geos
-      - name: hoc_activity
+      - name: hoc_activity