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

Commit

Permalink
Refresh docs (#376)
Browse files Browse the repository at this point in the history 
* Updates to documentation
Remove references .tools
Update proxy command docs
Update sample console output

* Added docs for Firebase Functions for Google

* Added Google Analytics to mkdocs

* Slight update

* Updated emulator page to exclude base URL

* More cleanup

* Removed unnecessary line about pathing

* Regenerated HTML docs
  • Loading branch information
@jkelvie
jkelvie committed Sep 7, 2017
1 parent f8cfd67 commit acae9b9
Show file tree
Hide file tree
Showing 36 changed files with 199 additions and 227 deletions.
38 changes: 19 additions & 19 deletions README.md
View file
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://bespoken.tools/">
<a href="https://bespoken.io/">
<img alt="BST" src="https://bespoken.io/wp-content/uploads/Bespoken-Logo-RGB-e1500333659572.png" width="546">
</a>
</p>
Expand All @@ -22,7 +22,7 @@
<a href="https://www.npmjs.com/package/bespoken-tools">
<img alt="NPM Version" class="badge" src="https://img.shields.io/npm/v/bespoken-tools.svg">
</a>
<a href="http://docs.bespoken.tools/">
<a href="http://docs.bespoken.io/">
<img alt="Read The Docs" class="badge" src="https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat">
</a>
<a href="https://gitter.im/bespoken/bst?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
Expand All @@ -40,16 +40,16 @@ With Bespoken, develop faster and better. Do not slow-down for:

The command-line tools include:

* [Deploy](http://docs.bespoken.tools/en/latest/commands/deploy) - One-command deployment of Lambda functions
* [Proxy](http://docs.bespoken.tools/en/latest/commands/proxy) - Easily debug Alexa requests by having them send directly to your laptop
* [Speak](http://docs.bespoken.tools/en/latest/commands/speak) and [Intend](http://docs.bespoken.tools/en/latest/commands/intend) - Send intents and utterances to your Alexa skill
* [Launch](http://docs.bespoken.tools/en/latest/commands/launch) - Send a Launch Request to your Alexa skill
* [Deploy](http://docs.bespoken.io/en/latest/commands/deploy) - One-command deployment of Lambda functions
* [Proxy](http://docs.bespoken.io/en/latest/commands/proxy) - Easily debug Alexa requests by having them send directly to your laptop
* [Speak](http://docs.bespoken.io/en/latest/commands/speak) and [Intend](http://docs.bespoken.io/en/latest/commands/intend) - Send intents and utterances to your Alexa skill
* [Launch](http://docs.bespoken.io/en/latest/commands/launch) - Send a Launch Request to your Alexa skill

The library provides:

* [BSTAlexa](http://docs.bespoken.tools/en/latest/api/classes/bstalexa.html) - Alexa emulator for unit-testing and functional-testing of your skills
* [BSTEncode](http://docs.bespoken.tools/en/latest/api/classes/bstencode.html) - Encodes audio files for use in SSML without pesky ffmpeg
* [Logless](http://docs.bespoken.tools/en/latest/api/classes/logless.html) - Completely painless, serverless logging
* [BSTAlexa](http://docs.bespoken.io/en/latest/api/classes/bstalexa.html) - Alexa emulator for unit-testing and functional-testing of your skills
* [BSTEncode](http://docs.bespoken.io/en/latest/api/classes/bstencode.html) - Encodes audio files for use in SSML without pesky ffmpeg
* [Logless](http://docs.bespoken.io/en/latest/api/classes/logless.html) - Completely painless, serverless logging

# Installation

Expand All @@ -65,22 +65,22 @@ For use of the Bespoken library (including Logless and the Emulator):
$ npm install bespoken-tools --save
```

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

## Tutorials For Alexa Skills
* [Nodejs Lambda Tutorial](http://docs.bespoken.tools/en/latest/tutorials/tutorial_lambda_nodejs)
* [Java Server Tutorial](http://docs.bespoken.tools/en/latest/tutorials/tutorial_local_server_java)
* [Python & Flask-Ask](http://docs.bespoken.tools/en/latest/tutorials/tutorial_flask_ask_python)
* [Alexa Emulator Tutorial - Node.js](http://docs.bespoken.tools/en/latest/tutorials/tutorial_bst_emulator_nodejs)
* [Nodejs Lambda Tutorial](http://docs.bespoken.io/en/latest/tutorials/tutorial_lambda_nodejs)
* [Java Server Tutorial](http://docs.bespoken.io/en/latest/tutorials/tutorial_local_server_java)
* [Python & Flask-Ask](http://docs.bespoken.io/en/latest/tutorials/tutorial_flask_ask_python)
* [Alexa Emulator Tutorial - Node.js](http://docs.bespoken.io/en/latest/tutorials/tutorial_bst_emulator_nodejs)

## Tutorials For Actions on Google
* [With Cloud Functions](http://docs.bespoken.tools/en/latest/tutorials/tutorial_cloud_function)
* [With API.AI](http://docs.bespoken.tools/en/latest/tutorials/tutorial_configuring_api_ai)
* [With Cloud Functions](http://docs.bespoken.io/en/latest/tutorials/tutorial_cloud_function)
* [With API.AI](http://docs.bespoken.io/en/latest/tutorials/tutorial_configuring_api_ai)

## Tutorials For General Lambdas
* [Running Lambdas Locally](http://docs.bespoken.tools/en/latest/tutorials/tutorial_lambda_local)
* [Debugging Lambdas Locally](http://docs.bespoken.tools/en/latest/tutorials/tutorial_lambda_debugger)
* [Deploying Lambdas](http://docs.bespoken.tools/en/latest/tutorials/tutorial_lambda_deploy)
* [Running Lambdas Locally](http://docs.bespoken.io/en/latest/tutorials/tutorial_lambda_local)
* [Debugging Lambdas Locally](http://docs.bespoken.io/en/latest/tutorials/tutorial_lambda_debugger)
* [Deploying Lambdas](http://docs.bespoken.io/en/latest/tutorials/tutorial_lambda_deploy)

## Questions/Feedback?

Expand Down
6 changes: 2 additions & 4 deletions docs/alexa_skills_kit_configuration.md
View file
@@ -1,7 +1,7 @@

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.

![bst proxy](https://bespoken.tools/assets/bst-proxy-flow.gif)
![bst proxy](https://bespoken.io/wp-content/uploads/bst-proxy-flow.gif)

## Configure your Skill Endpoint ###

Expand All @@ -17,12 +17,10 @@ https://determined-rice.bespoken.link

From your [Skill's list](https://developer.amazon.com/edw/home.html#/skills/list), select an existing skill to edit or create a new one. Navigate to the Configuration step and update the HTTPS endpoint to the one provided by the proxy command.

![bst proxy endpoint](https://bespoken.tools/assets/posts/introducing-bst-proxy-for-alexa-skills/configure-skill.gif)
![bst proxy endpoint](https://bespoken.io/wp-content/uploads/configure-skill.gif)

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#bst-proxy-urlgen)

## Path Component for proxy http

When using bst proxy http for local servers running on a specific port, you need to make sure your path components are correct.
Expand Down
28 changes: 14 additions & 14 deletions docs/api/classes/alexacontext.html
View file
Expand Up @@ -122,7 +122,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L16">alexa/alexa-context.ts:16</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L16">alexa/alexa-context.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -157,7 +157,7 @@ <h3>access<wbr>Token</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L50">alexa/alexa-context.ts:50</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L50">alexa/alexa-context.ts:50</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -174,7 +174,7 @@ <h3>active<wbr>Session</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L78">alexa/alexa-context.ts:78</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L78">alexa/alexa-context.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand All @@ -191,7 +191,7 @@ <h3>applicationID</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L23">alexa/alexa-context.ts:23</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L23">alexa/alexa-context.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -208,7 +208,7 @@ <h3>audio<wbr>Player</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L58">alexa/alexa-context.ts:58</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L58">alexa/alexa-context.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AudioPlayer</span></h4>
Expand All @@ -225,7 +225,7 @@ <h3>audio<wbr>Player<wbr>Enabled</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L62">alexa/alexa-context.ts:62</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L62">alexa/alexa-context.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand All @@ -242,7 +242,7 @@ <h3>end<wbr>Session</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L74">alexa/alexa-context.ts:74</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L74">alexa/alexa-context.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand All @@ -259,7 +259,7 @@ <h3>interaction<wbr>Model</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L35">alexa/alexa-context.ts:35</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L35">alexa/alexa-context.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InteractionModel</span></h4>
Expand All @@ -276,7 +276,7 @@ <h3>new<wbr>Session</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L66">alexa/alexa-context.ts:66</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L66">alexa/alexa-context.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand All @@ -293,7 +293,7 @@ <h3>session</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L70">alexa/alexa-context.ts:70</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L70">alexa/alexa-context.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="alexasession.html" class="tsd-signature-type">AlexaSession</a></h4>
Expand All @@ -310,7 +310,7 @@ <h3>set<wbr>Access<wbr>Token</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L54">alexa/alexa-context.ts:54</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L54">alexa/alexa-context.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -333,7 +333,7 @@ <h3>set<wbr>UserID</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L46">alexa/alexa-context.ts:46</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L46">alexa/alexa-context.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -356,7 +356,7 @@ <h3>skillURL</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L31">alexa/alexa-context.ts:31</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L31">alexa/alexa-context.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -373,7 +373,7 @@ <h3>userID</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-context.ts#L39">alexa/alexa-context.ts:39</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-context.ts#L39">alexa/alexa-context.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand Down
14 changes: 7 additions & 7 deletions docs/api/classes/alexasession.html
View file
Expand Up @@ -113,7 +113,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L9">alexa/alexa-session.ts:9</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L9">alexa/alexa-session.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="alexasession.html" class="tsd-signature-type">AlexaSession</a></h4>
Expand All @@ -133,7 +133,7 @@ <h3>attributes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L17">alexa/alexa-session.ts:17</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L17">alexa/alexa-session.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
Expand All @@ -155,7 +155,7 @@ <h3>id</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L28">alexa/alexa-session.ts:28</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L28">alexa/alexa-session.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -172,7 +172,7 @@ <h3>is<wbr>New</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L36">alexa/alexa-session.ts:36</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L36">alexa/alexa-session.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand All @@ -189,7 +189,7 @@ <h3>setID</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L32">alexa/alexa-session.ts:32</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L32">alexa/alexa-session.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -212,7 +212,7 @@ <h3>update<wbr>Attributes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L21">alexa/alexa-session.ts:21</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L21">alexa/alexa-session.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -235,7 +235,7 @@ <h3>used</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/alexa-session.ts#L40">alexa/alexa-session.ts:40</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/alexa-session.ts#L40">alexa/alexa-session.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/classes/audioitem.html
View file
Expand Up @@ -115,7 +115,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/audio-item.ts#L7">alexa/audio-item.ts:7</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/audio-item.ts#L7">alexa/audio-item.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -137,7 +137,7 @@ <h3>stream</h3>
<div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <a href="audioitemstream.html" class="tsd-signature-type">AudioItemStream</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/audio-item.ts#L7">alexa/audio-item.ts:7</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/audio-item.ts#L7">alexa/audio-item.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -154,7 +154,7 @@ <h3>clone</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/035a102/lib/alexa/audio-item.ts#L20">alexa/audio-item.ts:20</a></li>
<li>Defined in <a href="https://github.com/bespoken/bst/blob/a97095d/lib/alexa/audio-item.ts#L20">alexa/audio-item.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down

0 comments on commit acae9b9

Please sign in to comment.