Skip to content

Commit ce9feae

Browse files
committedMar 13, 2018
Update README with more info
2 parents 338b64d + 57c36de commit ce9feae

File tree

1 file changed

+10
-48
lines changed

1 file changed

+10
-48
lines changed
 

‎README.md

+10-48
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,19 @@
1-
# DevNet Writing Guidelines (Public)
1+
## Cisco DevNet Learning Labs Sample Code for Coding Skills
22

3-
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.
3+
These code examples provide Python scripts to perform network automation tasks such as creating a ticket or getting a list of network hosts or devices.
44

5-
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](https://github.com/CiscoDevNet/devnet-writing-guidelines/wiki) page.
5+
The step-by-step tutorials that work with this code are Learning Labs, displayed within the [Cisco DevNet Learning Labs system](https://learninglabs.cisco.com).
66

7-
<b>On this page</b><br>
7+
Contributions are welcome, and we are glad to review changes through pull requests. See [contributing.md](contributing.md) for details.
88

9-
> [Learning Labs](#learning-labs)<br>
10-
[How do I author a learning lab?](#learning-labs)<br>
11-
> [Templates](#templates)<br>
12-
> [Code Conventions](#code-conventions)<br>
13-
> [Author Scripts](##author-scripts)<br>
14-
> [Recommended Tools](##recommended-tools)<br>
9+
The goal of these learning labs is to ensure a 'hands-on' learning approach rather than just theory or instructions.
1510

16-
## Learning Labs
11+
## Contributing
1712

18-
The source markdown for all of DevNet's learning labs are stored in the repos of the [CiscoDevNet](https://github.com/CiscoDevNet) organization.
13+
These samples are for public consumption, so you must ensure that you have the rights to any code that you contribute.
1914

20-
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](https://github.com/CiscoDevNet) organization. The lab's markdown, images, JSON metadata, etc must exist in a certain directory structure. The next section explains how to do that.
15+
## Getting Involved
2116

22-
### How do I author a learning lab?
17+
* If you'd like to contribute examples for an existing lab, refer to [contributing.md](contributing.md).
18+
* If you're interested in creating a new Cisco DevNet Learning Lab or code example, please contact a DevNet administrator for guidance.
2319

24-
See the wiki page: [How To Create A New Lab](https://github.com/CiscoDevNet/devnet-writing-guidelines/wiki/How-To-Create-A-New-Lab)
25-
26-
### Templates
27-
28-
There are two kinds of templates: one for labs and one for sample code.
29-
30-
#### Lab template
31-
32-
The learning lab template is stored in the following directory:
33-
34-
> https://github.com/CiscoDevNet/devnet-writing-guidelines/tree/master/labs
35-
36-
37-
#### Sample Code template
38-
39-
The template for code samples is here:
40-
41-
> https://github.com/CiscoDevNet/devnet-writing-guidelines/tree/master/code-samples
42-
43-
## Code Conventions
44-
45-
See the [wiki](https://github.com/CiscoDevNet/devnet-writing-guidelines/wiki) for the style guide on DevNet coding conventions.
46-
47-
48-
## Author Scripts
49-
50-
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.
51-
52-
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.
53-
54-
55-
## Recommended Tools
56-
57-
Check the [wiki](https://github.com/CiscoDevNet/devnet-writing-guidelines/wiki/Tools-to-Write-Learning-Labs) section for recommended tools.

0 commit comments

Comments
 (0)
Failed to load comments.