Skip to content

Commit afb580b

Browse files
committed
Updates to README for branch name and local preview
1 parent ae823c5 commit afb580b

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
These self-paced interactive tutorials provide an introduction to coding.
44

5-
Labs are written to be displayed within the [Cisco DevNet Learning Labs system](https://learninglabs.cisco.com).
5+
Labs are written to be displayed within the [Cisco DevNet Learning Labs system](https://developer.cisco.com/learning).
66

77
Contributions are welcome, and we are glad to review changes through pull requests. See [contributing.md](contributing.md) for details.
88

99
Once approved, Cisco DevNet reviewers then create a release that is published through our Learning Labs system.
1010

11-
The goal of these learning labs is to ensure a 'hands-on' learning approach rather than just theory or instructions.
11+
The goal of these Learning Labs is to ensure a 'hands-on' learning approach rather than just theory or instructions.
1212

1313
## About these Learning Labs
1414

@@ -18,19 +18,7 @@ If you need more help, reach out to DevNet through one of our [support options](
1818

1919
## Preview Learning Lab Markdown locally
2020

21-
You can preview how the Markdown renders by using a pre-built Docker image. The `Makefile` in the root of the repository lets you run `make preview` to view the output HTML.
22-
23-
1. Make sure you have Docker installed locally. If not, [install Docker](https://docs.docker.com/install/) for your operating system.
24-
```
25-
$ docker -v
26-
```
27-
1. In the root of the repository, run:
28-
```
29-
$ make preview
30-
```
31-
1. Open a browser window with the URL: `http://localhost:9000`.
32-
1. Click a folder to find the Markdown file you want to preview.
33-
1. When you are done previewing, type `Ctrl+C` to stop running the Docker container.
21+
Refer to the instruction for your text editor for Markdown previewing. For example, [Markdown and Visual Studio Code](https://code.visualstudio.com/Docs/languages/markdown) describes how to configure Markdown extensions.
3422

3523
## Contributing
3624

@@ -45,9 +33,9 @@ To create and publish a new lab, take the following steps:
4533
- Create a JSON file with the same name as the `labs/`_folder_ name.
4634
- Create markdown files named 1.md, 2.md, and so on; refer to those files in the `labs/`_folder_ JSON file.
4735
- Ensure that the JSON file contains appropriate page titles and file references.
48-
- Send a pull request to get the files committed and merged to `master` by a DevNet reviewer.
36+
- Send a pull request to get the files committed and merged to the default branch by a DevNet reviewer.
4937

50-
A DevNet reviewer then creates a release on the repository with the latest `master` and publishes through the admin interface.
38+
A DevNet reviewer then creates a release on the repository with the latest changes and publishes through the admin interface.
5139

5240
#### Editors
5341

0 commit comments

Comments
 (0)