Skip to content

Commit 41f4139

Browse files
authored
Merge pull request #76 from CiscoDevNet/update-readme-file
Update readme file to latest template
2 parents 7dc14ca + e33f7fb commit 41f4139

File tree

1 file changed

+14
-40
lines changed

1 file changed

+14
-40
lines changed

README.md

Lines changed: 14 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,35 @@
1-
# Cisco DevNet Learning Lab: git-intro
1+
## Cisco DevNet Learning Labs: Coding Fundamentals
22

3-
**Description**: This is a tutorial that provides an introduction to coding. It is written to be displayed within the [Cisco DevNet Learning Labs system](https://learninglabs.cisco.com).
3+
These self-paced interactive tutorials provide an introduction to coding.
44

5-
- **Technology stack**: Built using Markdown.
6-
- **Status**: Beta status.
5+
Labs are written to be displayed within the [Cisco DevNet Learning Labs system](https://learninglabs.cisco.com).
76

8-
## Dependencies
7+
Contributions are welcome, and we are glad to review changes through pull requests. See [contributing.md](contributing.md) for details.
98

10-
* None
9+
Once approved, Cisco DevNet reviewers then create a release that is published through our Learning Labs system.
1110

12-
## Installation
11+
The goal of these learning labs is to ensure a 'hands-on' learning approach rather than just theory or instructions.
1312

14-
1. Clone (or fork then clone) this project
13+
## About these Learning Labs
1514

16-
## Configuration
15+
These Learning Labs are for building your home networking lab for network programmability.
1716

18-
No configuration necessary.
17+
If you need more help, reach out to DevNet through one of our [support options](https://developer.cisco.com/site/devnet/support/).
1918

20-
## Usage
21-
22-
* You can view these files using a Markdown editor.
23-
24-
## Link checking
25-
26-
You can run a link checker such as the Node-based [markdown-link-check](https://github.com/tcort/markdown-link-check) recursively through all labs by running:
27-
28-
```
29-
$ cd labs
30-
$ find . -name \*.md -exec echo "File: {}" \; -exec markdown-link-check {} \;
31-
```
32-
33-
## Known issues
34-
35-
* None
19+
## Contributing
3620

3721
These learning modules are for public consumption, so you must ensure that you have the rights to any content that you contribute.
3822

3923
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.)
4024

41-
#### Publishing Requirements
25+
#### Publishing requirements
4226

4327
To create and publish a new lab, take the following steps:
4428
- Add a new folder under `labs`.
4529
- Create a JSON file with the same name as the `labs/`_folder_ name.
4630
- Create markdown files named 1.md, 2.md, and so on; refer to those files in the `labs/`_folder_ JSON file.
4731
- 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.
32+
- Send a pull request to get the files committed and merged to `master` by a DevNet reviewer.
4933

5034
A DevNet reviewer then creates a release on the repository with the latest `master` and publishes through the admin interface.
5135

@@ -60,17 +44,7 @@ You can write Markdown in a plain text editor, but there are many desktop and We
6044

6145
You can validate a JSON file by using the [online formatter and validator](https://jsonformatter.curiousconcept.com).
6246

63-
## Getting help
64-
65-
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
66-
67-
## License
68-
[LICENSE](LICENSE)
69-
7047
## Getting involved
7148

72-
* If you'd like to make contributions, feel free to make a request in the issue tracker. If you're interested in creating a Cisco DevNet Learning Lab, contact Ashley Roach (asroach at cisco.com).
73-
74-
## Credits and references
75-
76-
* [Cisco DevNet Learning Labs](https://learninglabs.cisco.com)
49+
* If you'd like to contribute to an existing lab, refer to [contributing.md](contributing.md).
50+
* If you're interested in creating a new Cisco DevNet Learning Lab, please contact a DevNet administrator for guidance.

0 commit comments

Comments
 (0)