Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Commit

Permalink
Merge 2b112aa into f18a540
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelmyers committed Aug 31, 2016
2 parents f18a540 + 2b112aa commit c823af8
Show file tree
Hide file tree
Showing 18 changed files with 106 additions and 588 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ typings/globals/
typings/modules/

# generated docs
docs/_build/*
docs/site/

# Include all stuff under test/resources
!test/resources/*
Expand Down
12 changes: 6 additions & 6 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,27 +59,27 @@ Deploy new server version (from Docker Templates):

## Building

Make sure you have sphinx, sphinx-autobuild, recommonmark (for markdown), and the RTDs theme
Make sure you have mkdocs installed

```bash
$ pip install sphinx sphinx-autobuild recommonmark sphinx_rtd_theme
$ pip install mkdocs
```

Then, from root project root directory, build HTML with using the makefile:
Then, from root project root directory, build HTML:

```bash
$ make html -C docs/
$ mkdocs build
```

## Writing

When writing the docs, it is often helpful to autogen the HTML after every change:

```
$ sphinx-autobuild docs/ docs/_build/html
$ mkdocs serve --livereload
```

If things are not updating and you think something isn't right, clean the docs:
```bash
$ make clean -C docs/
$ mkdocs build -c
```
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Bespoken Tools (bst) - Tools for Alexa Skills Kit Development
====================

[![Build Status](https://travis-ci.org/bespoken/bst.svg?branch=master)](https://travis-ci.org/bespoken/bst) [![Coverage Status](https://coveralls.io/repos/github/bespoken/bst/badge.svg?branch=master)](https://coveralls.io/github/bespoken/bst?branch=master) [![npm version](https://img.shields.io/npm/v/bespoken-tools.svg)](https://www.npmjs.com/package/bespoken-tools)
[![Stories in Ready](https://badge.waffle.io/bespoken/bst.svg?label=ready&title=Ready)](http://waffle.io/bespoken/bst) [![Join the chat at https://gitter.im/bespoken/bst](https://badges.gitter.im/bespoken/bst.svg)](https://gitter.im/bespoken/bst?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/bespoken/bst.svg?branch=master)](https://travis-ci.org/bespoken/bst) [![Coverage Status](https://coveralls.io/repos/github/bespoken/bst/badge.svg?branch=master)](https://coveralls.io/github/bespoken/bst?branch=master) [![npm version](https://img.shields.io/npm/v/bespoken-tools.svg)](https://www.npmjs.com/package/bespoken-tools) [![Read the Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://docs.bespoken.tools/) [![Stories in Ready](https://badge.waffle.io/bespoken/bst.svg?label=ready&title=Ready)](http://waffle.io/bespoken/bst) [![Join the chat at https://gitter.im/bespoken/bst](https://badges.gitter.im/bespoken/bst.svg)](https://gitter.im/bespoken/bst?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


## Overview
Expand Down Expand Up @@ -31,7 +30,7 @@ Using NPM:
$ npm install bespoken-tools -g
```

For additional help, see [Getting Started](http://docs.bespoken.tools/en/latest/getting-started.html)
For additional help, see [Getting Started](http://docs.bespoken.tools/en/latest/getting_started.html)

## bst proxy Command

Expand Down
216 changes: 0 additions & 216 deletions docs/Makefile

This file was deleted.

3 changes: 1 addition & 2 deletions docs/alexa_skills_kit_configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Configuring your Skill for bst proxy

In order to leverage the bst proxy functionality, you must configure your skill from the Amazon Developer Console to point to the bst proxy server.

Expand All @@ -22,7 +21,7 @@ From your [Skill's list](https://developer.amazon.com/edw/home.html#/skills/list

Make sure Account linking is set to "No" and on the SSL Certificate step select "My development endpoint is a subdomain of a domain that has a wildcard certificate from a certificate authority".

__ Note__ To help generate your configuration URL, you can also use [$ bst proxy urlgen](/commands/proxy.html#bst-proxy-urlgen)
__ Note__ To help generate your configuration URL, you can also use [bst proxy urlgen](/commands/proxy#bst-proxy-urlgen)

## Path Component for proxy http

Expand Down
10 changes: 4 additions & 6 deletions docs/commands/proxy.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
bst proxy
=========

## Overview
The proxy command allows you to interact with a local service running on your machine via an Alexa device. Using it, you can make changes to code running on your machine and immediately make them available via an Echo or the Alexa simulator.

The proxy tool works either directly with Node/JavaScript lambda code - **proxy lambda**. Or it can proxy any http service using **proxy http**.

The two commands are described below, as well as the urlgen helper command.

## bst proxy lambda

**Overview**
Expand All @@ -32,7 +30,7 @@ Example:
$ bst proxy lambda index.js
```

You can learn more here at our [Node.js Tutorial](/tutorials/tutorial_lambda_nodejs.html):
You can learn more here at our [Node.js Tutorial](/tutorials/tutorial_lambda_nodejs):

## bst proxy http

Expand All @@ -54,7 +52,7 @@ Example:
$ bst proxy http 9999
```

You can learn more here at our [Java Tutorial](/tutorials/tutorial_local_server_java.html)
You can learn more here at our [Java Tutorial](/tutorials/tutorial_local_server_java)

## bst proxy urlgen

Expand All @@ -74,7 +72,7 @@ _Note the Node ID passed in the query string. This is a UUID that ties off your

The rest of the URL path and query string should be unchanged.

For more information on configuring your Skill see [Configuring your Skill for bst proxy](/alexa_skills_kit_configuration.html).
For more information on configuring your Skill see [Configuring your Skill for bst proxy](/alexa_skills_kit_configuration).

**Usage**

Expand Down
12 changes: 5 additions & 7 deletions docs/commands/speak.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
bst speak
=========

## Overview

Expand Down Expand Up @@ -33,11 +31,11 @@ By default, the system will:

If no service is currently running via bst proxy, and HTTP endpoint can be specified with the `--url` option:
```
$ bst speak Hello World --url https://my.skill.com/skill/path
$ bst speak Hello World --url https://my.skill.com/skill/path
```

## Speech Asset Format and Location
If your speech assets (Intent Model and Sample Utterances) are not stored under ./speechAssets, you can use an option to specify another location.
If your speech assets (Intent Model and Sample Utterances) are not stored under ./speechAssets, you can use an option to specify another location.

By default, we look for:

Expand All @@ -46,12 +44,12 @@ By default, we look for:

Example:
```
$ bst speak https://my.skill.com/skill/path Hello World -i interactions/IntentSchema.json -s interactions/SampleUtterances.txt
$ bst speak https://my.skill.com/skill/path Hello World -i interactions/IntentSchema.json -s interactions/SampleUtterances.txt
```

The format of these files is the same as they are entered in the Alexa Skill configuration.
The Intent Schema is a JSON file. Samples utterances is a space-delimited text file.

The Intent Schema is a JSON file. Samples utterances is a space-delimited text file.

An example of these files can be found [here](https://github.com/amzn/alexa-skills-kit-js/tree/master/samples/helloWorld/speechAssets).

Expand Down
Loading

0 comments on commit c823af8

Please sign in to comment.