Skip to content

Learning Labs JSON file parameters

Anne Gentle edited this page Mar 28, 2022 · 10 revisions
Parameter Description -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[ items→ title Title to be displayed in UI for step.
items→ content ] Markdown file name for this step.
config
These are config details required to instantiate related services for the Learning Lab like DevEnv, video, sandbox, quizzes. Sub services are optional and extendible in the future.
config→ devEnv DevEnv: is a dynamic developer environment that provides a console and code editor in the browser.
config→ devEnv →id
There will be multiple Docker images for devEnv that will have preinstalled SDK and sample code for a specific product. Specify devEnv that should be created as part of this lab
config→ devEnv →defaultFile
DevEnv will clone a sample code repository that may include code related to multiple Labs. This field will specify a file name that is relevant to a specific lab.
config → video Video can be directly embedded in lab step following PubHub markdown syntax. But if the Lab includes an intro video that needs to be previewed before starting, then it can be specified here.
config → video → URL
video url
config → video → type
youtube ( later DevNet may support other video hosting platforms)
config → sandbox future ( sandbox instantiation using Sandbox API)
config → sandbox → ID
ID for a sandbox that needs to be reserved or used for this Lab.
config → sandbox → type
additional detail like alowayson| reservable | cached, etc that will be used by the orchestrator.
config → quiz Quiz will mostly be at module level but if required can be supported a Lab level
config → quiz → ID
quiz id as created in q&a service.
config → quiz → type
Must | pass percentage | optional etc
config → future services*** Extendible in the future.
meta
Field from existing learning lab config.
meta→ slug Couple of line description of Learning Lab
meta → time Estimated time to complete lab
meta → tags Open-ended tags (NOTE: during the approval process admin can also define standard metadata catalog tags like the product, technology, programming languages, and so on. )
meta→ author Author details backward compatible (later may be removed as this can be auto drive from submitter information)
meta → byod backward compatible ( May become less relevant with DevEnv)