Skip to content

Commit 06cec9a

Browse files
committed
docs: more source info
1 parent 1e34049 commit 06cec9a

File tree

4 files changed

+14
-9
lines changed

4 files changed

+14
-9
lines changed

models/_docs/docs.md

+7
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,10 @@ The username of the learner
106106
{% docs verb_id %}
107107
The xAPI verb identifier
108108
{% enddocs %}
109+
110+
111+
{% docs object_tag_source %}
112+
Course objects and their associated tags from CMS events:
113+
`COURSE_CREATED, XBLOCK_CREATED, LIBRARY_BLOCK_CREATED, CONTENT_OBJECT_ASSOCIATIONS_CHANGED`
114+
and `post_save` Django signal on the Object Tag model
115+
{% enddocs %}

models/courses/sources.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sources:
77
tables:
88

99
- name: course_blocks
10-
description: "XBlock data from CMS COURSE_PUBLISHED events"
10+
description: XBlock data from CMS `COURSE_PUBLISHED` events
1111
columns:
1212
- name: org
1313
description: '{{ doc("org")}}'
@@ -38,7 +38,7 @@ sources:
3838
type: String
3939

4040
- name: course_overviews
41-
description: "Course metadata from CMS COURSE_PUBLISHED events"
41+
description: Course metadata from CMS `COURSE_PUBLISHED` events
4242
columns:
4343
- name: org
4444
description: '{{ doc("org")}}'

models/tags/sources.yml

+3-5
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ sources:
66
tables:
77

88
- name: object_tag
9-
description: >
10-
Course objects and their associated tags from events:
11-
CMS - COURSE_CREATED, XBLOCK_CREATED, LIBRARY_BLOCK_CREATED, CONTENT_OBJECT_ASSOCIATIONS_CHANGED
9+
description: '{{ doc("object_tag_source") }}'
1210
columns:
1311
- name: id
1412
description: '{{ doc("id") }}'
@@ -39,7 +37,7 @@ sources:
3937
type: String
4038

4139
- name: taxonomy
42-
description: Taxonomy data table
40+
description: Taxonomy data from `post_save` Django signal on the Taxonomy model
4341
columns:
4442
- name: id
4543
description: '{{ doc("id") }}'
@@ -55,7 +53,7 @@ sources:
5553
type: String
5654

5755
- name: tag
58-
description: All tags for all taxonomies. Includes parent tag and lineage string for heirarchal relationships
56+
description: Tag data from `post_save` Django signal on the Tag model. Includes parent tag and lineage string for heirarchal relationships.
5957
columns:
6058
- name: id
6159
description: '{{ doc("id") }}'

models/users/sources.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sources:
66
tables:
77

88
- name: user_profile
9-
description: All users and associated data
9+
description: Users and associated data from `post_save` Django signal on the UserProfile model
1010
columns:
1111
- name: id
1212
description: '{{ doc("id") }}'
@@ -72,7 +72,7 @@ sources:
7272
type: String
7373

7474
- name: external_id
75-
description: User ID with external id
75+
description: User ID with external id from `post_save` Django signal on the ExternalId model
7676
columns:
7777
- name: external_user_id
7878
description: "The external user id"

0 commit comments

Comments
 (0)