Skip to content

Commit fa2b059

Browse files
committed
Update Blog “open-sourcing-workshops-on-demand-part-5-create-a-workshop”
1 parent 7bb5c62 commit fa2b059

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

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

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ As an admin of the Workshops-on-demand infrastructure, I had to perform sever
4949
3. ###### Providing to the developer the necessary information to connect to the test/dev and staging backend servers.
5050
4. ###### Copy over the workshop developer's home folder a workshop template containing examples of introduction, conclusion and lab notebooks, allowing him to start his work.
5151

52+
OR
53+
54+
Give the developer the wod-notebook repo url for him to fork the repo and work locally on his machine.
55+
56+
Whenever ready, a pull request can be made. The admin can then review and accept it. The admin can then perform the necessary steps to prepare the infrastructure to host the workshop.
57+
5258
##### On the database server:
5359

5460
In order to exist, a workshop requires serveral entries in the database:
@@ -103,7 +109,7 @@ A new entry will need the following:
103109
* **WorkshopId:** Id of the workshop linked to the video.
104110
* **Active:** Tag to set to enable visibility of the replay in registration portal.
105111

106-
one could create these entries manually or leverage a simple wod.yml fiel containing them and that can be later parsed in order to feed the database with the relevant info, quite handy,no ?
112+
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 ?
107113

108114
Here is an exampe of such a file:
109115

@@ -140,10 +146,10 @@ As the developer of the Workshops-on-demand content, Matt had to perform seve
140146

141147
##### On the backend server:
142148

143-
1. ###### Log on to the backend server and clone the notebook repo in his home folder.
144-
2. ###### Create a new branch for his workshop following the naming convention defined with the admin and clone the notebooks repo.
149+
1. ###### Log on to the backend server and clone the notebook repo in his home folder or as explained earlier fork the repo on his laptop and work from there.
150+
2. ###### Create a new branch for his workshop following the naming convention defined with the admin.
145151
3. ###### Leverage the template provided by me to build up the content of his workshop.
146-
4. ###### Test the workshop leveraging the `test-action.sh` script
152+
4. ###### Test the workshop locally on his laptop or on the dev server leveraging the `test-action.sh` script
147153
5. ###### Test the workshop using the staging registration portal.
148154
6. ###### When all tests are green, create a pull request to merge content with master repo.
149155

@@ -190,8 +196,7 @@ the workshop will require:
190196
* A set of variables to be leveraged by the notebooks. These variables are to be set in yml format. They will be parsed at deployment times to set student ids, appliance IP addresses, and other relevant parameters like ports, simulated hardware information for instance.
191197

192198

193-
194-
Whenever all the scripts are functional and that the necessary actions have been performed both on backend and frontend servers, some functional tests can conducted using cli and later webui.
199+
Whenever all the scripts are functional and that the necessary actions have been performed both on backend and frontend servers, some functional tests can conducted using cli and later webui as described earlier for the simple workshop example.
195200

196201
* From the cli on the jupyterhub server:
197202

@@ -217,6 +222,8 @@ A workshop should come up with at least :
217222
* A README.md (0-ReadMeFirst.ipynb in md format)
218223
* wod.yml ( for database injection)
219224
225+
When all tests validated the workshop, it can follow the move to prod cycle.
226+
220227
221228
222229

0 commit comments

Comments
 (0)