search

CiscoDevNet / learning-labs-issues

Defects and bugs in learning lab content and project management
4 stars 0 forks source link

Remove Docker instructions for Markdown preview in each README #273

Closed annegentle closed 2 years ago

annegentle commented 4 years ago

Write up short pointers to Atom and VSCode Markdown previewers instead of Docker instructions.

annegentle commented 4 years ago

Also update the template README in instructions and cookie-cutter repos.

https://github.com/CiscoDevNet/devnet-writing-guidelines/tree/master/labs

https://github.com/CiscoDevNet/cookiecutter-devnet-learning-lab

https://github.com/CiscoDevNet/cookiecutter-devnet-learning-module

annegentle commented 4 years ago

In each Learning Lab repository, the README has a section about previewing Markdown. It needs to be updated with new text since the Docker instructions no longer work. Use this text:

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.
annegentle commented 2 years ago

I'm closing this Issue as I was able to loop through all the repos and update the READMEs.