Giter Club home page Giter Club logo

training-scenarios's Introduction

Interactive Katacoda Scenarios

Thanks for contributing to PatternFly Developer Training! Listed below are steps to follow when adding a training scenario.

Writing Scenarios

Visit https://www.katacoda.com/docs to learn more about creating Katacoda scenarios For examples, visit https://github.com/katacoda/scenario-example

We have put together a template to use when putting together a scenario, feel free to Make a Copy of this document.

Consistent structure for step instructions Having a consistent structure will help users skim the contents to find the chunks of info they're looking for without having to read more than they want to.

Step title, written as imperative that describes at a high level the theme for this step (e.g. overriding variables)

Statement that sets context for this step, possibly referencing the previous step, but also describes more explicitly the tasks the user will complete in the context of the scenario (e.g. define a variable to use in a card).

  1. Imperative statement about this sub-task. Additional statements if needed to explain why this sub-task is important.

Imperative statement that explicitly describes how to complete this task.

Then, another imperative statement, as needed to complete this task.

Hint: A hint that shows exactly what change the user should see in their workspace.

Note: Include a note for a sub-task if it's possible that a user could be confused about something. This is a place to include additional explanation about a concept that would be too much to include with the sub-task description.

Code to manually copy or with the "click to copy" button, if needed

Scenario Feedback

In the finish.md file add a link to our qualtrics survey so that feedback can be recorded. Use this link: https://redhatdg.co1.qualtrics.com/jfe/form/SV_bIRZRHYJyGsKBSt?Module= and at the end of Module= add the title of the scenario so that we can target feedback.

training-scenarios's People

Contributors

abigaeljamie avatar christiemolloy avatar cntlsn avatar dgutride avatar dlabrecq avatar gheake2 avatar gsoria avatar jenny-s51 avatar jgiardino avatar lareplog avatar nicolethoen avatar rebeccaalpert avatar seanforyou23 avatar

Watchers

 avatar

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.