Git Product home page Git Product logo

cookiecutter-devnet-learning-lab's Introduction

cookiecutter-devnet-learning-lab

A cookiecutter template for creating DevNet Learning Labs quickly

If you are creating an entirely new module, you may want to start here: https://github.com/CiscoDevNet/cookiecutter-devnet-learning-module

If you are working in an existing module, you can add an additional lab to that module by running the following in the labs folder of your existing module.

How to use this template

Make sure you install the Python cookiecutter library, then use this command to run through template prompts:

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

Sample workflow

➜  my-awesome-learning-module cd labs
➜  labs ls
my-awesome-learning-lab
➜  labs pwd
/tmp/Projects/my-awesome-learning-module/labs
➜  labs cookiecutter gh:ciscodevent/cookiecutter-devnet-learning-lab   
lab_name [my-awesome-learning-lab]: another-lab
lab_title [lab title]: another title
lab_slug [One sentence description of the learning lab.]:
lab_tag [One word or short phrase to categorize this lab.]: 
author_name [John Smith]:
author_email [[email protected]]:
➜  labs
➜  labs ls
another-lab             my-awesome-learning-lab

Don't have cookiecutter?

Install it with this command, typically inside a virtual environment:

$ pip install cookiecutter

cookiecutter-devnet-learning-lab's People

Contributors

agentlecisco avatar annegentle avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

cookiecutter-devnet-learning-lab's Issues

Extra " output in the Title

Love this start. Just a few minor issues that I'll log here so you get all the Issue checkbox goodness!

The JSON that was output has this line with an extra quote so the JSON is invalid:

"title": "The ELK Stack is My Awesome Learning Lab"",

Can cookiecutter also add a README with templated text and a contributing.md?

I'd love to have all the Learning Lab repos use the same README, and there should only be a few places to fill in:

Title
First sentence saying what the labs do generally.
Answer a couple of questions in the `## About these labs`` section.

Then also next to the README we have a contributing.md file that doesn't need any templated text. Is it possible to make the folder and these two additional files? If so, this is a gold medal!

More descriptive text for lab_slug

How about a bit more text explaining what the slug should contain? Ideally it's a description in a sentence of the lab itself.

Example:

"slug": "Getting started with the Meraki Dashboard API",

So instead of the hint being "some slug information" - how about "One sentence description of the learning lab."

Makefile in lab directory doesn't work

The makefile that is created with the lab is located within the lab directory itself, which makes the volume mapping not work.

The makefile at the root of the repo works as a single location works great so I've just been deleting the in lab makefile.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.