update visibility templates (#132)

gSchool · May 7, 2024 · a9239f4 · a9239f4
1 parent a28600a
commit a9239f4
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 7 deletions.
diff --git a/app/cmd/embeds/walkthrough/01-example-unit/01-configuration.md b/app/cmd/embeds/walkthrough/01-example-unit/01-configuration.md
@@ -8,7 +8,7 @@ Type: Lesson # Options: Lesson, Checkpoint, Survey, Instructor, Resource
 # Instructor files are only visible to instructors
 # Resources can be linked within content, but will not show up in the navigation side bar
 UID: unique-identifier # can be set to any string, must be unique in the repository
-# DefaultVisibility: hidden # Uncomment this line to default Lesson to hidden when used
+# DefaultVisibility: hidden # Uncomment this line to default Lesson to hidden. Please Note, this setting is applied only during the initial sync of a course file with a cohort.
 ---
 
 # Configuration

diff --git a/app/cmd/embeds/walkthrough/01-example-unit/05-checkpoint.md b/app/cmd/embeds/walkthrough/01-example-unit/05-checkpoint.md
@@ -2,7 +2,7 @@
 # autoconfig.yml will use these settings. config.yml will override.
 Type: Checkpoint
 UID: 2df27a2d-6db3-4dd6-aa82-2e6169e5b77f
-# DefaultVisibility: hidden # Uncomment this line to default Checkpoint to hidden
+# DefaultVisibility: hidden # Uncomment this line to default Checkpoint to hidden. Please Note, this setting is applied only during the initial sync of a course file with a cohort.
 MaxCheckpointSubmissions: 1
 # EmailOnCompletion: true #  Uncomment this line to send instructors an email once a student has completed a checkpoint
 TimeLimit: 60

diff --git a/app/cmd/markdown/files/checkpoint.go b/app/cmd/markdown/files/checkpoint.go
@@ -18,7 +18,7 @@ const checkpointTemplate = `---
 # autoconfig.yml will use these settings. config.yml will override.
 Type: Checkpoint
 UID: %s
-# DefaultVisibility: hidden # Uncomment this line to default Checkpoint to hidden
+# DefaultVisibility: hidden # Uncomment this line to default Checkpoint to hidden. Please Note, this setting is applied only during the initial sync of a course file with a cohort.
 # MaxCheckpointSubmissions: 1 # Uncomment this line to limit the number of submissions
 # EmailOnCompletion: true #  Uncomment this line to send instructors an email once a student has completed a checkpoint
 # TimeLimit: 60 # Uncomment this line to set a time limit in minutes

diff --git a/app/cmd/markdown/files/fileheader.go b/app/cmd/markdown/files/fileheader.go
@@ -18,7 +18,7 @@ const fileHeaderTemplate = `---
 # autoconfig.yml will use these settings. config.yml will override.
 Type: Lesson # Options: Lesson, Checkpoint, Survey, Instructor, Resource
 UID: %s
-# DefaultVisibility: hidden # Uncomment this line to default Lesson to hidden
+# DefaultVisibility: hidden # Uncomment this line to default Lesson to hidden. Please note, the default visibility setting is applied only during the initial sync of a course file within a cohort.
 # MaxCheckpointSubmissions: 1 # Checkpoints only. Uncomment this line to limit the number of submissions
 # EmailOnCompletion: true # Checkpoints only. Uncomment this line to send instructors an email once a student has completed a checkpoint
 # TimeLimit: 60 # Checkpoints only. Uncomment this line to set a time limit in minutes

diff --git a/app/cmd/markdown/files/lesson.go b/app/cmd/markdown/files/lesson.go
@@ -18,7 +18,7 @@ const lessonTemplate = `---
 # autoconfig.yml will use these settings. config.yml will override.
 Type: Lesson
 UID: %s
-# DefaultVisibility: hidden # Uncomment this line to default Lesson to hidden
+# DefaultVisibility: hidden # Uncomment this line to default Lesson to hidden. Please note, the default visibility setting is applied only during the initial sync of a course file within a cohort.
 # END FILE CONFIGURATION YML HEADER <<<<<
 ---
 

diff --git a/app/cmd/markdown/files/survey.go b/app/cmd/markdown/files/survey.go
@@ -18,7 +18,7 @@ const surveyTemplate = `---
 # autoconfig.yml will use these settings. config.yml will override.
 Type: Survey
 UID: %s
-# DefaultVisibility: hidden # Uncomment this line to default Survey to hidden
+# DefaultVisibility: hidden # Uncomment this line to default Survey to hidden. Please note, the default visibility setting is applied only during the initial sync of a course file within a cohort.
 # END FILE CONFIGURATION YML HEADER <<<<<
 ---
 

diff --git a/app/cmd/markdown/yaml/courseyaml.go b/app/cmd/markdown/yaml/courseyaml.go
@@ -19,7 +19,7 @@ const courseYamlTemplate = `# Course.yaml files specify the grouping and orderin
 #
 # Supported Fields
 # ===================
-# DefaultUnitVisibility -- (optional) set to 'hidden' to hide all units when a course first starts.
+# DefaultUnitVisibility -- (optional) set to 'hidden' to hide all units when a course first starts. Visibility setting is applied only during the initial sync of a course.
 # Course -- The top level array containing the sections of a course
 # Course.Section -- An array contining a single array of repos. Content in the same section is grouped together on curriculum homepage.
 # Course.Repos --  An array containing block repos that have been published in Learn.