Welcome to the DevNet Writing Guidelines. This repo contains DevNet's guidelines on creating learning labs, code samples, slides and setting up sandboxes for labs.
The topics below are some of the topics of most interest to newbies. For more the complete set of writing guidelines see this repo's wiki page.
On this page
Learning Labs
How do I author a learning lab?
Templates
Code conventions
Author scripts
Recommended tools
The source Markdown for all of DevNet's learning labs are stored in the repos of the CiscoDevNet organization.
If you want to create and publish a Lab on the DevNet site, you must commit the lab and its associated files to a repo within the CiscoDevNet organization. The lab's Markdown, images, JSON metadata, and so on must exist in a certain directory structure. The next section explains how to do that.
See the wiki page: How To Create A New Lab
There are two kinds of templates: one for labs and one for sample code.
The Learning Lab template is stored in the following directory of this repo and also replicated in the CiscoDevNet/cookiecutter repo.
https://github.com/CiscoDevNet/devnet-writing-guidelines/tree/master/labs
The template for code samples is here:
https://github.com/CiscoDevNet/devnet-writing-guidelines/tree/master/code-samples
See the wiki for the style guide on DevNet coding conventions.
The scripts folder contains python scripts that might be useful when authoring. You do not have to use these scripts to author labs. They are just helpful tools that other authors have created.
For example, the create_new_lab.py script creates a directory structure and copies the template used to create a new lab. You could do the same thing manually.
Check the wiki section for recommended tools.