@ -347,14 +347,22 @@ Get familiar with "The Creative Commons copyright licenses".
Creative Commons is an international nonprofit that offers flexible copyright management tools for creative work. Many learning objects have CC licences.
Creative Commons is an international nonprofit that offers flexible copyright management tools for creative work. Many learning objects have CC licences.
====
====
image::images/llo/llo-publish.png[]
When you are finished creating your Learning Object, Use "git push" to push commits to swarmlab.io repository
image::images/llo/llo-publish.png[]
- Find the url where the yaml-index resides.
- Whithin the "Publish Learning Object" menu you can choose to publish your LLO
*After that you can admin your LLO using the "My Lab Learning Object".*
==== Bootstrap
==== Bootstrap
image::images/llo/llo-bootstrap.png[]
image::images/llo/llo-bootstrap.png[]
===== index
Learning Objects Notebooks Based on the following structure:
Learning Objects Notebooks Based on the following structure:
[source,yaml]
[source,yaml]
@ -392,7 +400,7 @@ Learning Objects Notebooks Based on the following structure:
<3> The ''base url'' field is the landing page of your LLO.
<3> The ''base url'' field is the landing page of your LLO.
<4> Code spec
<4> Code spec
<5> Task Name
<5> Task Name
<6> A Swarmlab service is an dockerized microservice. It receives code snippets to execute, runs these code snippets, and returns the result and output of the execution.
<6> A Swarmlab service is an dockerized microservice. It receives code snippets to execute, runs these code snippets, and returns the result and output of the execution (Click on Field [Service] will show all available services to use).
<7> Task info. Here you can describe your Task
<7> Task info. Here you can describe your Task
<8> Set the programming language!
<8> Set the programming language!
<9> The full path of the executable
<9> The full path of the executable
@ -416,7 +424,7 @@ This example LO is organized as follows
│ └── q-info // <7>
│ └── q-info // <7>
└── intro // <8>
└── intro // <8>
----
----
<1> Bare Directory - based on: LabLearningObject Name
<1> Base Directory - based on: LabLearningObject Name
<2> Code spec - based on: display_name
<2> Code spec - based on: display_name
<3> Code snippets to execute
<3> Code snippets to execute
<4> Contain the answer.
<4> Contain the answer.
@ -432,6 +440,81 @@ Swarmlab.io notebooks are organized in files easy to collaborate using version
====
====
===== Text
Text can be added to swarmlab.io Notebooks using https://asciidoctor.org/docs/[Ascidoctor]
[NOTE]
====
Asciidoctor is a fast text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook 5, EPUB3, PDF and other formats. Asciidoctor is the leading implementation of the AsciiDoc syntax, first introduced and implemented in the Python-based AsciiDoc project.
====
===== Why AsciiDoc?
* Standardized format
** The formatting of Asciidoc is standardized so there is only one 'flavor' unlike in Markdown. The definitive user guide is http://asciidoctor.org/docs/asciidoc-writers-guide/[here]
* Asciidoctor can convert directly to HTML or DocBook.
AsciiDoc is about being able to focus on expressing your ideas, writing with ease and passing on knowledge without the distraction of complex applications or angle brackets.
AsciiDoc works because:
- It’s readable
- It’s concise
- It’s comprehensive
- It’s extensible
- It produces beautiful output (HTML, DocBook, PDF, ePub and more)
AsciiDoc is easy to write and easy to read (in raw form). It’s also easy to proof and edit. After all, it’s plain text, just like that familiar e-mail.
Best of all, it only requires a text editor to read or write.
===== AsciiDoc vs Markdown
The defacto lightweight markup language is Markdown. (At least, that’s what you call it at first). *The main advantage of Markdown lies in its primitive syntax:* its manual and cheatsheet are one and the same. *But this advantage is also its greatest weakness.*
As soon as authors need something slightly more complex than basic prose (e.g., tables, cross references, footnotes, embedded YouTube videos, etc.), they find themselves *resorting to embedded HTML* or seeking out more feature-rich implementations. Markdown has become a maze of different implementations, termed “flavors”, which make a universal definition evasive.
[NOTE]
====
The IETF has declared “there is no such thing as "invalid" Markdown.” https://tools.ietf.org/html/rfc7763#section-1.1[See This Is Markdown! Or: Markup and Its Discontents.]
====
Here’s how the story inevitably goes.
- You start out with Markdown.
- Then it’s Markdown + X.
- Then Markdown + X + Y.
- And down the rabbit hole you go.
*What’s worse, X and Y often require you to sprinkle in HTML, unnecessarily coupling content with presentation and wrecking portability. Your instinct to choose Markdown is good. There are just better options.*
===== Code
The Swarmlab Services offers an easy place to run your Source code.
you can create, run and share your live code right away without worrying about the system that's running
[NOTE]
====
Swarmlab Learning Object Notebooks are language agnostic
====
[NOTE]
====
As you see it's really easy to create a LO you may not even need the "Bootstrap LearningObject" menou.
Follow the instructions given in the "yaml-index" file and you'll be ready to start.
You can allways create a prototype LO from the menu and edit it later on.
zeus
4 years ago