Skip to content

Commit 2a9d37a

Browse files
committed
Update Blog “open-sourcing-workshops-on-demand-part-5-create-a-workshop”
1 parent 33c6c80 commit 2a9d37a

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

content/blog/open-sourcing-workshops-on-demand-part-5-create-a-workshop.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@ In this post, I won't focus on the subject selection process. I'll leave that to
2727

2828
What is a workshop? What do you need to develop ?
2929

30+
Let's imagine that you plan to create a new workshop on a topic on which you have knowledge to transfer. Let's call him **Matt**. He was kind enough to agree with working with me on creating a new workshop. After our first meeting, where I explained the creation process, and the expectations, we were able to quickly start working together. We defined what is needed:
31+
3032
* A set of notebooks that will be used by the student:
3133

3234
* Containing instructions cells in markdown and run code cells leveraging the relevant kernel. If you are not familiar with Jupyter notebooks, a simple [101 workshop](https://developer.hpe.com/hackshack/workshop/25) is available in our Workshops-on-Demand 's catalog.
3335

34-
A workshop should have with at least :
36+
A workshop should contain at least :
3537

3638
* 0-ReadMeFirst.ipynb
3739
* 1-WKSHP-LAB1.ipynb
@@ -42,10 +44,7 @@ A workshop should have with at least :
4244
* A README.md (0-ReadMeFirst.ipynb in md format)
4345

4446

45-
46-
47-
48-
to make the workshop compliant to our platform, you just need to provide a final file that contains a set of metadata that will be used for the workshop's integration into the infrastructure. this file is called wod.yml
47+
To make the workshop compliant to our platform, Matt just needs to provide a final file that contains a set of metadata that will be used for the workshop's integration into the infrastructure. this file is called **wod.yml**.
4948

5049
One could create these entries manually or leverage a simple wod.yml file containing them and that can be later parsed in order to feed the database with the relevant info. Quite handy, no?
5150

@@ -85,6 +84,8 @@ the following file will be used to update the **workshops table** in the databas
8584
![](/img/wod-db-go-1.png "Workshop's fields in the Database.")
8685
![](/img/wod-db-go-2.png "Workshop's fields in the Database #2.")
8786

87+
As a contributor, Matt should be able to provide all the following details.
88+
8889
* **ID:** A workshop ID to be used by backend server automation and Replays table to reference the associated replay video of the workshop (automatically created at the import of the wod.yml file process)
8990
* **name:** The workshop's name as it will will be displayed on the registration portal
9091
* **notebook:** Name of the folder containing all the workshop's notebooks (automatically created at the import of the wod.yml file process)
@@ -94,6 +95,7 @@ the following file will be used to update the **workshops table** in the databas
9495
* **Category:** The workshops' registration portal proposes several filters to display the catlog's content. You can view all workshops, the most poular ones, or by category. Use this field to sort workshops accordingly
9596
* **Duration:** All workshops are time bombed. You will define here the time alloacted to perform the workshop
9697
* **Active:** Tag to set to enable visibility of the workshop's tile in the registration portal
98+
* **WorkshopImg:** As part of the lifecycle of the workshop, several emails are sent to the student. A workshop image is embbeded in the first emails
9799

98100
The following fields are required by the infrastructure.
99101

@@ -102,14 +104,10 @@ The following fields are required by the infrastructure.
102104
* **reset and ldap** entries are to be used by backend server automation if dedicated reset scripts and ldap authentication are required by the workshop
103105
* **session type:** Workshops-on-Demand by default
104106
* **location:** If your setup includes multiple production sites, use this field to allocate workshops according to your needs. In the case of the HPE Developer Community, some workshops can only run on a HPE GreenLake . As a consequence, the location is set to greenlake in this case
105-
106-
107-
108-
109107
* **Compile:** This entry will be filled with the name of a script to be compiled at deployment time. This feature allows the admin to hide login scripts and credentials in non-editable executable files
110108
* **Varpass:** This defines whether or not a workshop requires a password variable needs to be leveraged
111109

112-
* **WorkshopImg:** As part of the lifecycle of the workshop, several emails are sent to the student. A workshop image is embbeded in the first emails
110+
113111
* **BadgeImg:** As part of the lifecycle of the workshop, several emails are sent to the student. In the final email, a badge is included. It allows the student to share its accomplishment on social media like linkedin for instance
114112
* **Beta:** Not implemented yet :-)
115113

@@ -140,7 +138,7 @@ As I continue this series, I will explore two scenarios. In the first one, I wil
140138

141139
# Simple workshop example:
142140

143-
Let's imagine that I plan to create a new workshop in the Go language. Go has become more and more popular among the developer community I interact with and one developer (Let's call him **Matt**) was kind enough to agree with working with me on creating this new workshop. After our first meeting, where I explained the creation process, and the expectations, we were able to quickly start working together. We defined the title, abstract, notebooks' folder name, and student range. As far as the infrastructure's requirements, a new kernel was needed. No additional scripts were required for this workshop.
141+
As far as the infrastructure's requirements, a new kernel was needed. No additional scripts were required for this workshop.
144142

145143
As an admin of the Workshops-on-Demand infrastructure, I had to perform several tasks:
146144

0 commit comments

Comments
 (0)