Skip to content

Commit 543f96a

Browse files
authored
Update README.md
1 parent 9e4d14c commit 543f96a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,32 @@ $ find . -name \*.md -exec echo "File: {}" \; -exec markdown-link-check {} \;
3434

3535
* None
3636

37+
These learning modules are for public consumption, so you must ensure that you have the rights to any content that you contribute.
38+
39+
Write your content in Markdown. DevNet staff reviews content according to the [Cisco Style Guide](http://www-author.cisco.com/c/en/us/td/docs/general/style/guide/Latest/stylegd.html). (Link available on Cisco VPN only.)
40+
41+
#### Publishing Requirements
42+
43+
To create and publish a new lab, take the following steps:
44+
- Add a new folder under `labs`.
45+
- Create a JSON file with the same name as the `labs/`_folder_ name.
46+
- Create markdown files named 1.md, 2.md, and so on; refer to those files in the `labs/`_folder_ JSON file.
47+
- Ensure that the JSON file contains appropriate page titles and file references.
48+
- Send a pull request to get the files commited and merged to `master` by a DevNet reviewer.
49+
50+
A DevNet reviewer then creates a release on the repository with the latest `master` and publishes through the admin interface.
51+
52+
#### Editors
53+
54+
You can write Markdown in a plain text editor, but there are many desktop and Web-based options that allow you to write and preview your work at the same time. We recommend Visual Studio Code [Download](https://code.visualstudio.com/) for several reasons:
55+
- Lightweight environment for coding (or writing Markdown)
56+
- Available on Mac OS, Linux or Windows
57+
- Github Client integration
58+
- Great Markdown preview features native in the editor
59+
- Intuitive operation and structure
60+
61+
You can validate a JSON file by using the [online formatter and validator](https://jsonformatter.curiousconcept.com).
62+
3763
## Getting help
3864

3965
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

0 commit comments

Comments
 (0)