juju / juju-academy Goto Github PK

Learn to use Juju

CSS 25.77% JavaScript 74.23%

juju-academy's Introduction

Juju Academy

This site is designed to be a split pane terminal emulator to help introduce people to the concepts of Juju before having to ever install Juju. While Juju is arguably best learned by simply installing and doing, this site is designed to get people started up just as fast.

Installation

You'll need bower to run this.

npm install -g bower

Then install all the bower things

bower install

Creating new lessons

Lessons are jsonp files stored in the lessons directory. The format is relatively light weight and only requires a few keys wrapped in a load_lesson call.

name - The title of the lesson
```
'name': 'Title of lesson',
```

description - An array/list of paragraphs which discuss the lesson

'description': [
  'First paragraph',
  'second paragraph',
  'last paragraph'
]

tasks - This is an object which each key being a unique identifier for the task

Creating tasks

A task is an object with several keys which outlines how the task is to be satisfied.

name - The title of the task
hint - A brief description of to help the user along if they get stuck
validate - This can either be a string, an object, or a function.
- String - This should be a regular expression, used to determine if the task has been completed
- Object - An object containing at least a match key, which is a regular expression. An additional echo key can be added to provide additional output to the terminal
- Function - If a function, should implement a signature of Function(cmd, term, next) where cmd is the full command by the user, term is the terminal instance, and next is the function invoked when there isn't a match, passing at least a True or string as the first and only parameter.

Examples

{
  '00-first-task': {
    'name': 'First task!',
    'hint': 'Type, <code>first</code> to achieve this task',
    'validate': '^first$'
  },
  '01-second-task': {
    'name': 'Second task',
    'hint': 'Do this secondly',
    'validate': {
      'match': '^second .*$',
      'echo': 'This option is optional'
    }
  },
  '02-third-task': {
    'name': 'Last task!',
    'hint': 'This is the last one',
    'validate': function(cmd, term, next) {
      var m = cmd.match('^last (.*)$');
      if(!m) {
        return next(true);
      }
      term.echo('You said {0}'.format(m[1]));
      return next();
    }
  }
}

Creating new commands

juju-academy's People

Contributors

Stargazers

Watchers

Forkers

kadams54 mattyw howbazaar mattgriffin 0xf2 markandrewj kwmonroe marcoceppi mbruzek adamisrael hatched arosales plane123 mitechie jwood1 macduff23 fatash89 isabella232 davidwah

juju-academy's Issues

"All Lessons" button doesn't work in the UI

Add `ls` command

ls (-a should always be assumed and -l should print long format, all other flags should just be ignored but accepted). This should traverse the #fs object and print the hierarchy

Kick to gui at end of lesson with pre-deployed bundle

Typo in lesson #3

Lesson #3 spells "begin" as "being". Oops.

Implement juju help

Should have a 1:1 match of juju help output from cli tool, feedback from #1

juju generate-config isn't implemented

which we all know is to be used in preference to juju init

no "terminal" output in safari on OSX

Find me in IRC if you need to screenshare a mac with which to test.

Back button doesn't actually do anything

It should go back to previous lesson or be disabled when there is no further back button

feedback from #1

Timeout quickly for invalid charms during deploy

Link to juju documentation

in help output, feedback from #1

cat is unhealthy

demo@ubuntu:~$ cat
[USER]: Cannot read property '1' of null
TypeError: Cannot read property '1' of null
    at Array.eval (eval at <anonymous> (http://juju.academy/vendor/jquery/dist/jquery.min.js:
2:2533), <anonymous>:40:14)
    at Commands._exec (http://juju.academy/assets/js/commands.js:41:26)
    at http://juju.academy/assets/js/commands.js:44:19
    at Array.eval (eval at <anonymous> (http://juju.academy/vendor/jquery/dist/jquery.min.js:
2:2533), <anonymous>:11:14)
    at Commands._exec (http://juju.academy/assets/js/commands.js:41:26)
    at http://juju.academy/assets/js/commands.js:44:19
    at Array.eval (eval at <anonymous> (http://juju.academy/vendor/jquery/dist/jquery.min.js:
2:2533), <anonymous>:4:14)
    at Commands._exec (http://juju.academy/assets/js/commands.js:41:26)
    at http://juju.academy/assets/js/commands.js:44:19
    at Array.eval (eval at <anonymous> (http://juju.academy/vendor/jquery/dist/jquery.min.js:
2:2533), <anonymous>:341:14)

Enable tabcompletion

There should be a separate completion directory, which contains a dictionary of primary keys to function.

{
  'command': function(term, cb) {
    cb(['--flag', 'option', '~/.file']);
  },
  'other-command': function(term, cb) {
    // Do things
    cb(['more', 'options', 'to', 'reply', with']);
  }
}

Each key will be used to determine primary commands to autocomplete, for instance i there is a 'juju' key, then ju will tab complete to juju, subsequent tab completion requests will go to to the juju function defined in the completion dictionary.

Current lesson and task not tracked properly

Users can bookmark a page, but site will not take you to the right lesson/task if you come back in to parent

Steps completed in lesson do not carry over refreshes

Feedback from first run

First this is a solid tool to have get acclimated with Juju, and a framework to add in additional lessons as folks grow their skills and as the Juju community grows.

Feedback

General

Suggest to make it more apparent to click the task to see the hint.
I can't go back.

Opening Page

On the opening page it would be nice to have a link to juju.ubuntu.com and help.juju.academy 404's for me atm.

Setting Up Juju

I can't go back
It says "edit" ~/.juju/environments.yaml file, but I can't use vi, vim, sed, awk, perl, pico, nano, or emacs.
```
demo@ubuntu:~$ perl
 perl: command not found
 demo@ubuntu:~$ sed
 sed: command not found
 demo@ubuntu:~$ awk
 awk: command not found
 demo@ubuntu:~$ vi
 vi: command not found
 demo@ubuntu:~$ vim
 vim: command not found
 demo@ubuntu:~$ pico
 pico: command not found
 demo@ubuntu:~$ nano
 nano: command not found
 demo@ubuntu:~$ emacs
 emacs: command not found
```
- Which method would you like the user to edit the env.yaml file? Also, when you say edit the env.yaml to include the credentials of "demo"/"demo" do you want that in the form of keypairs, userpass, or something more generic. Perhaps being more specific on what method you want the user to edit env.yaml, and what yaml keys to enter may be helpful.

Your first bootstrap

First task I think is successful, but the command prompt returns command is not found

demo@ubuntu:~$ juju help commands
Sorry, help hasn't been implemented yet or action doesn't exist
demo@ubuntu:~$ juju help bootstrap
Sorry, help hasn't been implemented yet or action doesn't exist
demo@ubuntu:~$ juju help
Sorry, help hasn't been implemented yet or action doesn't exist

Really well put together. Looking forward to seeing how we can incorporate showing how deployed workload looks, ie seeing Wordpress running, or get the GUI deployed.

-thanks,
Antonio