Skip to content

Commit 547bd34

Browse files
update the set up instructions
1 parent 89e6cae commit 547bd34

1 file changed

Lines changed: 20 additions & 21 deletions

File tree

en/modules/ROOT/pages/new-course.adoc

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,6 @@ content:
3030

3131
== Managing the content
3232

33-
=== Content organization
34-
35-
----
36-
📁 _public <.>
37-
📁 .github <.>
38-
📁 course-material <.>
39-
📁 www <.>
40-
----
41-
42-
<.> This folder is used to store the automated built zip file of the content material. Do not remove it.
43-
<.> This folder contains the action configuration used to build the content automatically
44-
<.> This folder contains the course material i.e. LabVIEW code for exercices, examples, solutions and any other files needed to follow the course
45-
<.> This folder contains the webdsite for all the languages
46-
4733
=== Set up the content the first time
4834

4935
When starting the project, do the following:
@@ -53,14 +39,12 @@ When starting the project, do the following:
5339
+
5440
[source,yaml]
5541
----
56-
name: template-course <.>
57-
title: Template course <.>
42+
name: course_template <.>
43+
title: My template course <.>
5844
----
5945
+
60-
<.> make the title (see the next point) lower case and replace the white spaces by `-`
61-
<.> set the name of your course
62-
+
63-
IMPORTANT: the title attribute must have course in its name to be display in the website
46+
<.> The name attribute must start by `course_`, be lower case and not have white spaces
47+
<.> The value of the title attribute will be the one displayed on th ewebsite
6448
+
6549
. Edit the `set-up.adoc` file like described:
6650

@@ -75,7 +59,22 @@ NOTE: Add all the instructions needed to take the course in this section.
7559
* https://labviewcommunitytraining.github.io/Website-Course-Template/course-material.zip[Course material zip] <.>
7660
----
7761

78-
<.> Update the URL with the new project name.
62+
<.> Update the URL with the GitHub project name. In the example above, `Website-Course-Template` must be replace by your project name.
63+
64+
=== Content organization
65+
66+
----
67+
📁 _public <.>
68+
📁 .github <.>
69+
📁 course-material <.>
70+
📁 www <.>
71+
----
72+
73+
<.> This folder is used to store the automated built zip file of the content material. Do not remove it.
74+
<.> This folder contains the action configuration used to build the content automatically
75+
<.> This folder contains the course material i.e. LabVIEW code for exercices, examples, solutions and any other files needed to follow the course
76+
<.> This folder contains the webdsite for all the languages
77+
7978

8079
=== Edit the website content
8180

0 commit comments

Comments
 (0)