Welcome to the DevNet Writing Guidelines. This repo contains DevNet's guidelines on creating Learning Labs, code samples, and setting up sandboxes for Learning Labs.
The topics below are some of the topics of most interest to newcomers. For more the complete set of writing guidelines see this repo's wiki pages.
On this page
Learning Labs
How do I author a learning lab?
Templates
Code Conventions
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 Learning Lab on the DevNet site, you must commit the content and its associated files to a repo within the CiscoDevNet organization. The Markdown, images, JSON metadata, and so on must exist in a certain directory structure.
See the wiki page: How To Create A New Lab.
There are two kinds of templates: one for Learning Labs and one for sample code.
The Learning Lab template is stored in the following directory:
https://github.com/CiscoDevNet/devnet-writing-guidelines/tree/master/labs
The template for code samples is here:
See the wiki for the style guide on DevNet coding conventions.
Check the wiki section for recommended tools.