From a59b5566496b25f899df78a627143f4175e7259a Mon Sep 17 00:00:00 2001 From: John Kelvie Date: Tue, 22 Aug 2017 15:51:33 -0500 Subject: [PATCH 1/3] Updated docs in preparation for new site --- README.md | 6 ++-- docs/alexa_skills_kit_configuration.md | 18 +++++----- docs/api/classes/alexacontext.html | 28 +++++++-------- docs/api/classes/alexasession.html | 14 ++++---- docs/api/classes/audioitem.html | 6 ++-- docs/api/classes/audioitemstream.html | 8 ++--- docs/api/classes/bstalexa.html | 34 +++++++++---------- docs/api/classes/bstalexaevents.html | 10 +++--- docs/api/classes/bstencode.html | 10 +++--- docs/api/classes/bstproxy.html | 24 ++++++------- docs/api/classes/lambdaserver.html | 8 ++--- docs/api/classes/log.html | 14 ++++---- docs/api/classes/logless.html | 14 ++++---- docs/api/classes/loglesscontext.html | 26 +++++++------- docs/api/classes/loglessmiddleware.html | 6 ++-- docs/api/enums/logtype.html | 8 ++--- docs/api/enums/proxytype.html | 6 ++-- docs/api/index.html | 2 +- docs/api/interfaces/cloudfunction.html | 2 +- docs/api/interfaces/expresserrorhandler.html | 2 +- .../api/interfaces/expressrequesthandler.html | 2 +- docs/api/interfaces/iencoderconfig.html | 8 ++--- docs/api/interfaces/lambdafunction.html | 2 +- docs/api_nav.md | 2 +- docs/api_readme.md | 6 ++-- docs/getting_started.md | 4 +-- docs/index.md | 9 +++-- .../tutorials/tutorial_bst_emulator_nodejs.md | 2 +- docs/tutorials/tutorial_cloud_function.md | 2 +- docs/tutorials/tutorial_configuring_api_ai.md | 2 +- docs/tutorials/tutorial_flask_ask_python.md | 2 +- docs/tutorials/tutorial_lambda_deploy.md | 2 +- docs/tutorials/tutorial_lambda_local.md | 2 +- docs/tutorials/tutorial_lambda_nodejs.md | 2 +- gulpfile.js | 2 +- lib/client/bst-alexa.ts | 2 +- lib/client/function-server.ts | 2 +- lib/client/lambda-server.ts | 2 +- lib/logless/logless.ts | 3 ++ mkdocs.yml | 2 +- 40 files changed, 157 insertions(+), 149 deletions(-) diff --git a/README.md b/README.md index 7cbbc0c0..a20c8d56 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,13 @@ --- # Overview -With Bespoken Tools, develop faster and better. Do not slow-down for: +With Bespoken, develop faster and better. Do not slow-down for: * Time-consuming server deployments * Over-complicated and highly manual testing routines * Complex ffmpeg encoding and configuration -With Bespoken tools, build high-quality, faster. +With Bespoken, build high-quality, faster. The command-line tools include: @@ -61,7 +61,7 @@ For use of the CLI: $ npm install bespoken-tools -g ``` -For use of the Bespoken Tools library (including Logless and the Emulator): +For use of the Bespoken library (including Logless and the Emulator): ```bash $ npm install bespoken-tools --save diff --git a/docs/alexa_skills_kit_configuration.md b/docs/alexa_skills_kit_configuration.md index 55200de4..1744a870 100644 --- a/docs/alexa_skills_kit_configuration.md +++ b/docs/alexa_skills_kit_configuration.md @@ -9,10 +9,10 @@ When you run the bst proxy command, you will see a URL output: ```bash $ bst proxy lambda index.js -BST: v0.6.5 Node: v4.3.2 +BST: v1.0.4 Node: v4.3.2 -Your URL for Alexa Skill configuration: -https://proxy.bespoken.tools?node-id=0c6a4f17-c86f-4024-ba26-a351ac319431 +Your public URL for accessing your local service: +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. @@ -31,15 +31,15 @@ For example, when you run the bst proxy http command: ```bash $ bst proxy http 9999 -BST: v0.6.5 Node: v4.3.2 +BST: v1.0.4 Node: v4.3.2 -Your URL for Alexa Skill configuration: -https://proxy.bespoken.tools/YOUR/SKILL/PATH?node-id=0c6a4f17-c86f-4024-ba26-a351ac319431 -(Be sure to put in your real path and other query string parameters!) +Your public URL for accessing your local service: +https://determined-rice.bespoken.link ``` -And your local server listens on path `/alexa-skill`, you need to update the URL with your path before configuring your Skill. +If your local server listens on path `/alexa-skill`, you need to update the URL with your path before configuring your Skill. ``` -https://proxy.bespoken.tools/alexa-skill?node-id=0c6a4f17-c86f-4024-ba26-a351ac319431 +Your public URL for accessing your local service: +https://determined-rice.bespoken.link/alexa-skill ``` diff --git a/docs/api/classes/alexacontext.html b/docs/api/classes/alexacontext.html index 8e3a08be..aa20767f 100644 --- a/docs/api/classes/alexacontext.html +++ b/docs/api/classes/alexacontext.html @@ -122,7 +122,7 @@

constructor

  • Parameters

    @@ -157,7 +157,7 @@

    accessToken

  • Returns string

    @@ -174,7 +174,7 @@

    activeSession

  • Returns boolean

    @@ -191,7 +191,7 @@

    applicationID

  • Returns string

    @@ -208,7 +208,7 @@

    audioPlayer

  • Returns AudioPlayer

    @@ -225,7 +225,7 @@

    audioPlayerEnabled

  • Returns boolean

    @@ -242,7 +242,7 @@

    endSession

  • Returns void

    @@ -259,7 +259,7 @@

    interactionModel

  • Returns InteractionModel

    @@ -276,7 +276,7 @@

    newSession

  • Returns void

    @@ -293,7 +293,7 @@

    session

  • Returns AlexaSession

    @@ -310,7 +310,7 @@

    setAccessToken

  • Parameters

    @@ -333,7 +333,7 @@

    setUserID

  • Parameters

    @@ -356,7 +356,7 @@

    skillURL

  • Returns string

    @@ -373,7 +373,7 @@

    userID

  • Returns string

    diff --git a/docs/api/classes/alexasession.html b/docs/api/classes/alexasession.html index 2050c049..30956307 100644 --- a/docs/api/classes/alexasession.html +++ b/docs/api/classes/alexasession.html @@ -113,7 +113,7 @@

    constructor

  • Returns AlexaSession

    @@ -133,7 +133,7 @@

    attributes

  • Returns object

    @@ -155,7 +155,7 @@

    id

  • Returns string

    @@ -172,7 +172,7 @@

    isNew

  • Returns boolean

    @@ -189,7 +189,7 @@

    setID

  • Parameters

    @@ -212,7 +212,7 @@

    updateAttributes

  • Parameters

    @@ -235,7 +235,7 @@

    used

  • Returns void

    diff --git a/docs/api/classes/audioitem.html b/docs/api/classes/audioitem.html index 986340d8..8c83dbff 100644 --- a/docs/api/classes/audioitem.html +++ b/docs/api/classes/audioitem.html @@ -115,7 +115,7 @@

    constructor

  • Parameters

    @@ -137,7 +137,7 @@

    stream

    @@ -154,7 +154,7 @@

    clone

  • diff --git a/docs/api/classes/audioitemstream.html b/docs/api/classes/audioitemstream.html index f59ebfbf..7220fa41 100644 --- a/docs/api/classes/audioitemstream.html +++ b/docs/api/classes/audioitemstream.html @@ -94,7 +94,7 @@

    expectedPreviousToken

    expectedPreviousToken: string = null
    @@ -104,7 +104,7 @@

    offsetInMilliseconds

    offsetInMilliseconds: number
    @@ -114,7 +114,7 @@

    token

    token: string = null
    @@ -124,7 +124,7 @@

    url

    url: string = null
    diff --git a/docs/api/classes/bstalexa.html b/docs/api/classes/bstalexa.html index aedb50bc..ddba7b95 100644 --- a/docs/api/classes/bstalexa.html +++ b/docs/api/classes/bstalexa.html @@ -65,7 +65,7 @@

    Class BSTAlexa

    -

    Programmatic interface for interacting with the Bespoken Tools Alexa emulator.

    +

    Programmatic interface for interacting with the Bespoken Alexa emulator.

    Overview on usage can be found here. NodeJS tutorial here

    @@ -128,7 +128,7 @@

    constructor

  • @@ -184,7 +184,7 @@

    Static DefaultIntentSc
    DefaultIntentSchemaLocation: string = "speechAssets/IntentSchema.json"

  • @@ -194,7 +194,7 @@

    Static DefaultSampleUt
    DefaultSampleUtterancesLocation: string = "speechAssets/SampleUtterances.txt"
    @@ -211,7 +211,7 @@

    context

  • Returns AlexaContext

    @@ -228,7 +228,7 @@

    intended

  • @@ -301,7 +301,7 @@

    launched

  • @@ -357,7 +357,7 @@

    on

  • @@ -410,7 +410,7 @@

    once

  • @@ -463,7 +463,7 @@

    playbackFinished

  • @@ -519,7 +519,7 @@

    playbackNearlyFinished

  • @@ -575,7 +575,7 @@

    playbackOffset

  • @@ -605,7 +605,7 @@

    playbackStopped

  • @@ -661,7 +661,7 @@

    sessionEnded

  • @@ -723,7 +723,7 @@

    spoken

  • @@ -789,7 +789,7 @@

    start

  • @@ -838,7 +838,7 @@

    stop

  • diff --git a/docs/api/classes/bstalexaevents.html b/docs/api/classes/bstalexaevents.html index 38ba68b7..3023681e 100644 --- a/docs/api/classes/bstalexaevents.html +++ b/docs/api/classes/bstalexaevents.html @@ -95,7 +95,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackFinished: string = "AudioPlayer.PlaybackFinished"
    @@ -111,7 +111,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackNearlyFinished: string = "AudioPlayer.PlaybackNearlyFinished"
    @@ -127,7 +127,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackStarted: string = "AudioPlayer.PlaybackStarted"
    @@ -143,7 +143,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackStopped: string = "AudioPlayer.PlaybackStopped"
    @@ -159,7 +159,7 @@

    Static Response

    Response: string = "response"
    diff --git a/docs/api/classes/bstencode.html b/docs/api/classes/bstencode.html index c76f111b..9ab58e80 100644 --- a/docs/api/classes/bstencode.html +++ b/docs/api/classes/bstencode.html @@ -115,7 +115,7 @@

    constructor

  • @@ -151,7 +151,7 @@

    encodeFileAndPublish

  • @@ -206,7 +206,7 @@

    encodeFileAndPublishAs

  • @@ -267,7 +267,7 @@

    encodeURLAndPublish

  • @@ -325,7 +325,7 @@

    encodeURLAndPublishAs

  • diff --git a/docs/api/classes/bstproxy.html b/docs/api/classes/bstproxy.html index f558d850..0be02258 100644 --- a/docs/api/classes/bstproxy.html +++ b/docs/api/classes/bstproxy.html @@ -136,7 +136,7 @@

    constructor

  • Parameters

    @@ -158,7 +158,7 @@

    proxyType

    proxyType: ProxyType.GOOGLE_CLOUD_FUNCTION | ProxyType.HTTP | ProxyType.LAMBDA
    @@ -175,7 +175,7 @@

    activateSecurity

  • @@ -197,7 +197,7 @@

    bespokenServer

  • @@ -228,7 +228,7 @@

    port

  • @@ -258,7 +258,7 @@

    secretKey

  • Parameters

    @@ -281,7 +281,7 @@

    start

  • Parameters

    @@ -322,7 +322,7 @@

    stop

  • Parameters

    @@ -357,7 +357,7 @@

    targetDomain

  • Parameters

    @@ -380,7 +380,7 @@

    Static cloudFunction

  • @@ -411,7 +411,7 @@

    Static http

  • @@ -439,7 +439,7 @@

    Static lambda

  • diff --git a/docs/api/classes/lambdaserver.html b/docs/api/classes/lambdaserver.html index b9e050b0..a7b4cf59 100644 --- a/docs/api/classes/lambdaserver.html +++ b/docs/api/classes/lambdaserver.html @@ -67,7 +67,7 @@

    Class LambdaServer

    The LambdaServer wraps a Node.js Lambda routine in a simple HTTP service.

    -

    It makes it easy to test Lambdas locally, and in conjunction with our other Bespoken Tools.

    +

    It makes it easy to test Lambdas locally, and in conjunction with our other tools.

    To use it, simply provide the filename of the Lambda function along with the port the HTTP server should listen on.

    @@ -111,7 +111,7 @@

    constructor

  • @@ -171,7 +171,7 @@

    start

  • @@ -214,7 +214,7 @@

    stop

  • diff --git a/docs/api/classes/log.html b/docs/api/classes/log.html index 49db6c5a..7f067ad3 100644 --- a/docs/api/classes/log.html +++ b/docs/api/classes/log.html @@ -111,7 +111,7 @@

    constructor

  • Parameters

    @@ -142,7 +142,7 @@

    _timestamp

    _timestamp: Date
    @@ -152,7 +152,7 @@

    data

    data: any
    @@ -162,7 +162,7 @@

    Optional stack

    stack: string
    @@ -172,7 +172,7 @@

    Optional tags

    tags: Array<string>
    @@ -182,7 +182,7 @@

    type

    type: LogType.DEBUG | LogType.ERROR | LogType.INFO | LogType.WARN
    @@ -199,7 +199,7 @@

    timestampAsISOString

  • Returns string

    diff --git a/docs/api/classes/logless.html b/docs/api/classes/logless.html index f418cd7c..f5659274 100644 --- a/docs/api/classes/logless.html +++ b/docs/api/classes/logless.html @@ -67,6 +67,8 @@

    Class Logless

    Logless will automatically capture logs and diagnostics for your Node.js Lambda, Google Cloud Function or Express.js service.

    +

    Before you integrate the code, you will need to a key. You get it from the Bespoken Dashboard (requires registration/sign-in). + Once integrated, this is where your logs and data will be viewable.

    To use it with Lambdas, simply wrap your function handler, like so:

    
         var bst = require('bespoken-tools');
    @@ -154,7 +156,7 @@ 

    Static Domain

    Domain: string = "logless.bespoken.tools"
    @@ -171,7 +173,7 @@

    Static capture

  • @@ -205,7 +207,7 @@

    Static disableConsoleL
  • Returns void

    @@ -222,7 +224,7 @@

    Static enableConsoleLo
  • @@ -247,7 +249,7 @@

    Static logger

  • @@ -276,7 +278,7 @@

    Static middleware

  • diff --git a/docs/api/classes/loglesscontext.html b/docs/api/classes/loglesscontext.html index ada8f628..d37d6231 100644 --- a/docs/api/classes/loglesscontext.html +++ b/docs/api/classes/loglesscontext.html @@ -112,7 +112,7 @@

    constructor

  • Parameters

    @@ -138,7 +138,7 @@

    callback

  • Returns Function

    @@ -155,7 +155,7 @@

    captureConsole

  • @@ -183,7 +183,7 @@

    cleanup

  • Returns void

    @@ -200,7 +200,7 @@

    flush

  • Parameters

    @@ -235,7 +235,7 @@

    log

  • Parameters

    @@ -267,7 +267,7 @@

    logError

  • Parameters

    @@ -296,7 +296,7 @@

    newTransactionID

  • Returns void

    @@ -313,7 +313,7 @@

    onCloudFunctionEvent

  • Parameters

    @@ -339,7 +339,7 @@

    onLambdaEvent

  • Parameters

    @@ -368,7 +368,7 @@

    transactionID

  • Returns string

    @@ -385,7 +385,7 @@

    transmit

  • Parameters

    @@ -423,7 +423,7 @@

    wrapConsole

  • diff --git a/docs/api/classes/loglessmiddleware.html b/docs/api/classes/loglessmiddleware.html index bfb12ada..7dcc7162 100644 --- a/docs/api/classes/loglessmiddleware.html +++ b/docs/api/classes/loglessmiddleware.html @@ -102,7 +102,7 @@

    constructor

  • Parameters

    @@ -127,7 +127,7 @@

    errorHandler

    errorHandler: ExpressErrorHandler
    @@ -137,7 +137,7 @@

    requestHandler

    requestHandler: ExpressRequestHandler
    diff --git a/docs/api/enums/logtype.html b/docs/api/enums/logtype.html index cbc14cd0..094f1993 100644 --- a/docs/api/enums/logtype.html +++ b/docs/api/enums/logtype.html @@ -86,7 +86,7 @@

    DEBUG

    DEBUG:
    @@ -96,7 +96,7 @@

    ERROR

    ERROR:
    @@ -106,7 +106,7 @@

    INFO

    INFO:
    @@ -116,7 +116,7 @@

    WARN

    WARN:
    diff --git a/docs/api/enums/proxytype.html b/docs/api/enums/proxytype.html index 2bb3ea1a..be3505a7 100644 --- a/docs/api/enums/proxytype.html +++ b/docs/api/enums/proxytype.html @@ -85,7 +85,7 @@

    GOOGLE_CLOUD_FUNCTION

    GOOGLE_CLOUD_FUNCTION:
    @@ -95,7 +95,7 @@

    HTTP

    HTTP:
    @@ -105,7 +105,7 @@

    LAMBDA

    LAMBDA:
    diff --git a/docs/api/index.html b/docs/api/index.html index d6f6c029..ce42a159 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -60,7 +60,7 @@

    Bespoken Tools

    -

    Bespoken Tools Reference API

    +

    Bespoken Reference API

    Overview

    We currently only expose four primary classes:

      diff --git a/docs/api/interfaces/cloudfunction.html b/docs/api/interfaces/cloudfunction.html index 947d4da5..9d0fb1b9 100644 --- a/docs/api/interfaces/cloudfunction.html +++ b/docs/api/interfaces/cloudfunction.html @@ -79,7 +79,7 @@

      Callable

    • Parameters

      diff --git a/docs/api/interfaces/expresserrorhandler.html b/docs/api/interfaces/expresserrorhandler.html index cf4b4b7d..aa5e6b31 100644 --- a/docs/api/interfaces/expresserrorhandler.html +++ b/docs/api/interfaces/expresserrorhandler.html @@ -79,7 +79,7 @@

      Callable

    • Parameters

      diff --git a/docs/api/interfaces/expressrequesthandler.html b/docs/api/interfaces/expressrequesthandler.html index 7a2514c1..51c75349 100644 --- a/docs/api/interfaces/expressrequesthandler.html +++ b/docs/api/interfaces/expressrequesthandler.html @@ -79,7 +79,7 @@

      Callable

    • Parameters

      diff --git a/docs/api/interfaces/iencoderconfig.html b/docs/api/interfaces/iencoderconfig.html index fedab6a4..980eaa68 100644 --- a/docs/api/interfaces/iencoderconfig.html +++ b/docs/api/interfaces/iencoderconfig.html @@ -94,7 +94,7 @@

      accessKeyId

      accessKeyId: string
      @@ -109,7 +109,7 @@

      bucket

      bucket: string
      @@ -124,7 +124,7 @@

      Optional filterVolume

      filterVolume: number
      @@ -140,7 +140,7 @@

      secretAccessKey

      secretAccessKey: string
      diff --git a/docs/api/interfaces/lambdafunction.html b/docs/api/interfaces/lambdafunction.html index 91187e49..4236bd16 100644 --- a/docs/api/interfaces/lambdafunction.html +++ b/docs/api/interfaces/lambdafunction.html @@ -86,7 +86,7 @@

      Callable

    • diff --git a/docs/api_nav.md b/docs/api_nav.md index 38b1d04b..c32d97bc 100644 --- a/docs/api_nav.md +++ b/docs/api_nav.md @@ -5,4 +5,4 @@ Need this file until we can figure out how to either: For now, this exists to provide a link to the Typedoc API docs without a nav --> -The Bespoken Tools API reference can be found [here](api). \ No newline at end of file +The Bespoken API reference can be found [here](api). \ No newline at end of file diff --git a/docs/api_readme.md b/docs/api_readme.md index 22fefd78..709b0717 100644 --- a/docs/api_readme.md +++ b/docs/api_readme.md @@ -1,7 +1,7 @@ -Bespoken Tools Reference API -============================ +Bespoken Reference API +====================== # Overview -We currently only expose four primary classes: +We currently expose five primary classes: - [BSTAlexa](classes/bstalexa.html) - [BSTEncode](classes/bstencode.html) - [BSTProxy](classes/bstproxy.html) diff --git a/docs/getting_started.md b/docs/getting_started.md index a39a9f9d..359b5861 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -7,7 +7,7 @@ $ node --version && npm --version We support node version `4.x.x` and above. For help installing, see [How To Install NPM](http://blog.npmjs.org/post/85484771375/how-to-install-npm) -Next, install the bespoken tools command line tool (bst): +Next, install the Bespoken command line tool (bst): ``` $ npm install bespoken-tools -g ``` @@ -20,7 +20,7 @@ Verify the installation by typing: $ bst ``` -To work with the Bespoken Tools API, install it with your project as part of the package.json: +To work with the Bespoken API, install it with your project as part of the package.json: ``` npm install bespoken-tools --save ``` diff --git a/docs/index.md b/docs/index.md index c8faba4b..a20c8d56 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,6 +16,9 @@ Codecov + + Coverage Status + NPM Version @@ -29,13 +32,13 @@ --- # Overview -With Bespoken Tools, develop faster and better. Do not slow-down for: +With Bespoken, develop faster and better. Do not slow-down for: * Time-consuming server deployments * Over-complicated and highly manual testing routines * Complex ffmpeg encoding and configuration -With Bespoken tools, build high-quality, faster. +With Bespoken, build high-quality, faster. The command-line tools include: @@ -58,7 +61,7 @@ For use of the CLI: $ npm install bespoken-tools -g ``` -For use of the Bespoken Tools library (including Logless and the Emulator): +For use of the Bespoken library (including Logless and the Emulator): ```bash $ npm install bespoken-tools --save diff --git a/docs/tutorials/tutorial_bst_emulator_nodejs.md b/docs/tutorials/tutorial_bst_emulator_nodejs.md index f43c2010..d0a243c6 100644 --- a/docs/tutorials/tutorial_bst_emulator_nodejs.md +++ b/docs/tutorials/tutorial_bst_emulator_nodejs.md @@ -20,7 +20,7 @@ the BSTAlexa emulator can be used for testing regular Alexa skills as well. * If you do not have one and want to follow along at home, [try ours here](https://github.com/bespoken/streamer). * Derived from excellent streaming skill example provided by Amazon. * The test used in this tutorial is [found here](https://github.com/bespoken/streamer/blob/master/test/streamerTest.js). -* Bespoken Tools added to your project's package.json +* Bespoken tools added to your project's package.json * `$ npm install bespoken-tools --save-dev` * For this example, we make it a "dev" dependency as we will be using it only for testing. diff --git a/docs/tutorials/tutorial_cloud_function.md b/docs/tutorials/tutorial_cloud_function.md index e9715424..fb934213 100644 --- a/docs/tutorials/tutorial_cloud_function.md +++ b/docs/tutorials/tutorial_cloud_function.md @@ -3,7 +3,7 @@ This tutorial shows you how to get started developing for Actions on Google usin ## Prerequisites -* Bespoken Tools (bst) +* Bespoken command-line tools (bst) * `$ npm install bespoken-tools -g` * [Installation Instructions](/getting_started/) * Google Cloud account diff --git a/docs/tutorials/tutorial_configuring_api_ai.md b/docs/tutorials/tutorial_configuring_api_ai.md index 5b158573..2869a1e8 100644 --- a/docs/tutorials/tutorial_configuring_api_ai.md +++ b/docs/tutorials/tutorial_configuring_api_ai.md @@ -1,4 +1,4 @@ -This tutorial will help you get setup using API.AI with our sample project and Bespoken tools. +This tutorial will help you get setup using API.AI with our sample project and Bespoken. Ping us on [gitter](https://gitter.im/bespoken/bst) if you have any question. diff --git a/docs/tutorials/tutorial_flask_ask_python.md b/docs/tutorials/tutorial_flask_ask_python.md index d7d06129..a083b581 100644 --- a/docs/tutorials/tutorial_flask_ask_python.md +++ b/docs/tutorials/tutorial_flask_ask_python.md @@ -2,7 +2,7 @@ This tutorial shows you how to get started developing with bst for Alexa Skills ## Prerequisites -* bespoken tools (bst) +* Bespoken command-line tools (bst) * `$ npm install bespoken-tools -g` * [Installation Instructions](/getting_started/) * Amazon Developer Account diff --git a/docs/tutorials/tutorial_lambda_deploy.md b/docs/tutorials/tutorial_lambda_deploy.md index 046f764a..0f628bbd 100644 --- a/docs/tutorials/tutorial_lambda_deploy.md +++ b/docs/tutorials/tutorial_lambda_deploy.md @@ -1,5 +1,5 @@ -This tutorial shows you how to use the Bespoken Tools to test and deploy your Node.js AWS Lambdas. +This tutorial shows you how to use the Bespoken tools to test and deploy your Node.js AWS Lambdas. It will also show you how to install a Lambda that will access resources inside your private VPC. ## Use case diff --git a/docs/tutorials/tutorial_lambda_local.md b/docs/tutorials/tutorial_lambda_local.md index a4c2bcbe..cb889165 100644 --- a/docs/tutorials/tutorial_lambda_local.md +++ b/docs/tutorials/tutorial_lambda_local.md @@ -1,5 +1,5 @@ -This tutorial shows you how to use Bespoken Tools to test AWS Lambdas locally. +This tutorial shows you how to use Bespoken to test AWS Lambdas locally. Using this, you can send HTTP requests directly to and from your AWS Lambda (Node.js or Python) on your laptop. diff --git a/docs/tutorials/tutorial_lambda_nodejs.md b/docs/tutorials/tutorial_lambda_nodejs.md index 6f772e8d..3040be4f 100644 --- a/docs/tutorials/tutorial_lambda_nodejs.md +++ b/docs/tutorials/tutorial_lambda_nodejs.md @@ -3,7 +3,7 @@ This tutorial shows you how to get started developing for Alexa Skills Kit using ## Prerequisites -* bespoken tools (bst) +* Bespoken command-line tools (bst) * `$ npm install bespoken-tools -g` * [Installation Instructions](/getting_started/) * Amazon Developer Account diff --git a/gulpfile.js b/gulpfile.js index e2da11c5..ea24131e 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -140,7 +140,7 @@ gulp.task('typedoc', function () { excludeNotExported: true, excludeExternals: true, mode: 'file', - name: 'Bespoken Tools', + name: 'Bespoken', readme: 'docs/api_readme.md', target: 'ES6', out: 'docs/api', diff --git a/lib/client/bst-alexa.ts b/lib/client/bst-alexa.ts index 23f80dfb..5c168ab9 100644 --- a/lib/client/bst-alexa.ts +++ b/lib/client/bst-alexa.ts @@ -42,7 +42,7 @@ export class BSTAlexaEvents { } /** - * Programmatic interface for interacting with the Bespoken Tools Alexa emulator. + * Programmatic interface for interacting with the Bespoken Alexa emulator. * * Overview on usage can be found [here](../index.html). NodeJS tutorial [here](../../tutorials/tutorial_bst_emulator_nodejs) * diff --git a/lib/client/function-server.ts b/lib/client/function-server.ts index 8461cd84..ece37116 100644 --- a/lib/client/function-server.ts +++ b/lib/client/function-server.ts @@ -10,7 +10,7 @@ let Logger = "BST-FUNCTION"; /** * The FunctionServer wraps a Google Cloud Function routine in a simple HTTP service. * - * It makes it easy to test Cloud Functions locally, and in conjunction with our other Bespoken Tools. + * It makes it easy to test Cloud Functions locally, and in conjunction with our other tools. * * To use it, simply provide the filename of the Cloud function along with the port the HTTP server should listen on. */ diff --git a/lib/client/lambda-server.ts b/lib/client/lambda-server.ts index f0174c4e..9a2e9496 100644 --- a/lib/client/lambda-server.ts +++ b/lib/client/lambda-server.ts @@ -10,7 +10,7 @@ let Logger = "BST-LAMBDA"; /** * The LambdaServer wraps a Node.js Lambda routine in a simple HTTP service. * - * It makes it easy to test Lambdas locally, and in conjunction with our other Bespoken Tools. + * It makes it easy to test Lambdas locally, and in conjunction with our other tools. * * To use it, simply provide the filename of the Lambda function along with the port the HTTP server should listen on. */ diff --git a/lib/logless/logless.ts b/lib/logless/logless.ts index c59a8af4..4596e21d 100644 --- a/lib/logless/logless.ts +++ b/lib/logless/logless.ts @@ -4,6 +4,9 @@ import {LogType} from "./logless-context"; /** * Logless will automatically capture logs and diagnostics for your Node.js Lambda, Google Cloud Function or Express.js service. * + * Before you integrate the code, you will need to a key. You get it from [the Bespoken Dashboard](https://apps.bespoken.io/dashboard) (requires registration/sign-in). + * Once integrated, this is where your logs and data will be viewable. + * * To use it with Lambdas, simply wrap your function handler, like so: *
      
        *     var bst = require('bespoken-tools');
      diff --git a/mkdocs.yml b/mkdocs.yml
      index 4069de7b..4c2e1b6e 100644
      --- a/mkdocs.yml
      +++ b/mkdocs.yml
      @@ -1,4 +1,4 @@
      -site_name: bespoken.tools
      +site_name: bespoken.io
       repo_url: https://github.com/bespoken/bst
       site_dir: 'site'
       strict: true
      
      From 035a10227e6f97f84b9aab98d91475ed74c46cc1 Mon Sep 17 00:00:00 2001
      From: John Kelvie 
      Date: Tue, 22 Aug 2017 15:56:21 -0500
      Subject: [PATCH 2/3] Got rid of superfluous sentence
      
      ---
       README.md | 2 --
       1 file changed, 2 deletions(-)
      
      diff --git a/README.md b/README.md
      index a20c8d56..1ab03688 100644
      --- a/README.md
      +++ b/README.md
      @@ -38,8 +38,6 @@ With Bespoken, develop faster and better. Do not slow-down for:
       * Over-complicated and highly manual testing routines
       * Complex ffmpeg encoding and configuration
       
      -With Bespoken, build high-quality, faster.
      -
       The command-line tools include:
       
       * [Deploy](http://docs.bespoken.tools/en/latest/commands/deploy) - One-command deployment of Lambda functions  
      
      From 7501ba41ea8243113f8464502fe95d05a64fc6fd Mon Sep 17 00:00:00 2001
      From: John Kelvie 
      Date: Tue, 22 Aug 2017 15:58:28 -0500
      Subject: [PATCH 3/3] More documentation updates
      
      ---
       docs/api/classes/alexacontext.html            | 32 ++++++++---------
       docs/api/classes/alexasession.html            | 18 +++++-----
       docs/api/classes/audioitem.html               | 10 +++---
       docs/api/classes/audioitemstream.html         | 12 +++----
       docs/api/classes/bstalexa.html                | 36 +++++++++----------
       docs/api/classes/bstalexaevents.html          | 14 ++++----
       docs/api/classes/bstencode.html               | 14 ++++----
       docs/api/classes/bstproxy.html                | 28 +++++++--------
       docs/api/classes/lambdaserver.html            | 10 +++---
       docs/api/classes/log.html                     | 18 +++++-----
       docs/api/classes/logless.html                 | 18 +++++-----
       docs/api/classes/loglesscontext.html          | 30 ++++++++--------
       docs/api/classes/loglessmiddleware.html       | 10 +++---
       docs/api/enums/logtype.html                   | 12 +++----
       docs/api/enums/proxytype.html                 | 10 +++---
       docs/api/globals.html                         |  6 ++--
       docs/api/index.html                           |  8 ++---
       docs/api/interfaces/cloudfunction.html        |  6 ++--
       docs/api/interfaces/expresserrorhandler.html  |  6 ++--
       .../api/interfaces/expressrequesthandler.html |  6 ++--
       docs/api/interfaces/iencoderconfig.html       | 12 +++----
       docs/api/interfaces/lambdafunction.html       |  6 ++--
       docs/index.md                                 |  2 --
       lib/logless/logless.ts                        |  2 +-
       24 files changed, 162 insertions(+), 164 deletions(-)
      
      diff --git a/docs/api/classes/alexacontext.html b/docs/api/classes/alexacontext.html
      index aa20767f..a22e919b 100644
      --- a/docs/api/classes/alexacontext.html
      +++ b/docs/api/classes/alexacontext.html
      @@ -3,7 +3,7 @@
       
       	
       	
      -	AlexaContext | Bespoken Tools
      +	AlexaContext | Bespoken
       	
       	
       	
      @@ -22,7 +22,7 @@
       						
    • Preparing search index...
    • The search index is not available
    - Bespoken Tools + Bespoken
    @@ -122,7 +122,7 @@

    constructor

  • Parameters

    @@ -157,7 +157,7 @@

    accessToken

  • Returns string

    @@ -174,7 +174,7 @@

    activeSession

  • Returns boolean

    @@ -191,7 +191,7 @@

    applicationID

  • Returns string

    @@ -208,7 +208,7 @@

    audioPlayer

  • Returns AudioPlayer

    @@ -225,7 +225,7 @@

    audioPlayerEnabled

  • Returns boolean

    @@ -242,7 +242,7 @@

    endSession

  • Returns void

    @@ -259,7 +259,7 @@

    interactionModel

  • Returns InteractionModel

    @@ -276,7 +276,7 @@

    newSession

  • Returns void

    @@ -293,7 +293,7 @@

    session

  • Returns AlexaSession

    @@ -310,7 +310,7 @@

    setAccessToken

  • Parameters

    @@ -333,7 +333,7 @@

    setUserID

  • Parameters

    @@ -356,7 +356,7 @@

    skillURL

  • Returns string

    @@ -373,7 +373,7 @@

    userID

  • Returns string

    diff --git a/docs/api/classes/alexasession.html b/docs/api/classes/alexasession.html index 30956307..ca05f443 100644 --- a/docs/api/classes/alexasession.html +++ b/docs/api/classes/alexasession.html @@ -3,7 +3,7 @@ - AlexaSession | Bespoken Tools + AlexaSession | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken

  • @@ -113,7 +113,7 @@

    constructor

  • Returns AlexaSession

    @@ -133,7 +133,7 @@

    attributes

  • Returns object

    @@ -155,7 +155,7 @@

    id

  • Returns string

    @@ -172,7 +172,7 @@

    isNew

  • Returns boolean

    @@ -189,7 +189,7 @@

    setID

  • Parameters

    @@ -212,7 +212,7 @@

    updateAttributes

  • Parameters

    @@ -235,7 +235,7 @@

    used

  • Returns void

    diff --git a/docs/api/classes/audioitem.html b/docs/api/classes/audioitem.html index 8c83dbff..a5b6bccc 100644 --- a/docs/api/classes/audioitem.html +++ b/docs/api/classes/audioitem.html @@ -3,7 +3,7 @@ - AudioItem | Bespoken Tools + AudioItem | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
  • @@ -115,7 +115,7 @@

    constructor

  • Parameters

    @@ -137,7 +137,7 @@

    stream

    @@ -154,7 +154,7 @@

    clone

  • diff --git a/docs/api/classes/audioitemstream.html b/docs/api/classes/audioitemstream.html index 7220fa41..2fbe5f33 100644 --- a/docs/api/classes/audioitemstream.html +++ b/docs/api/classes/audioitemstream.html @@ -3,7 +3,7 @@ - AudioItemStream | Bespoken Tools + AudioItemStream | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -94,7 +94,7 @@

    expectedPreviousToken

    expectedPreviousToken: string = null
    @@ -104,7 +104,7 @@

    offsetInMilliseconds

    offsetInMilliseconds: number
    @@ -114,7 +114,7 @@

    token

    token: string = null
    @@ -124,7 +124,7 @@

    url

    url: string = null
    diff --git a/docs/api/classes/bstalexa.html b/docs/api/classes/bstalexa.html index ddba7b95..6afc40b7 100644 --- a/docs/api/classes/bstalexa.html +++ b/docs/api/classes/bstalexa.html @@ -3,7 +3,7 @@ - BSTAlexa | Bespoken Tools + BSTAlexa | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -128,7 +128,7 @@

    constructor

  • @@ -184,7 +184,7 @@

    Static DefaultIntentSc
    DefaultIntentSchemaLocation: string = "speechAssets/IntentSchema.json"
    @@ -194,7 +194,7 @@

    Static DefaultSampleUt
    DefaultSampleUtterancesLocation: string = "speechAssets/SampleUtterances.txt"
    @@ -211,7 +211,7 @@

    context

  • Returns AlexaContext

    @@ -228,7 +228,7 @@

    intended

  • @@ -301,7 +301,7 @@

    launched

  • @@ -357,7 +357,7 @@

    on

  • @@ -410,7 +410,7 @@

    once

  • @@ -463,7 +463,7 @@

    playbackFinished

  • @@ -519,7 +519,7 @@

    playbackNearlyFinished

  • @@ -575,7 +575,7 @@

    playbackOffset

  • @@ -605,7 +605,7 @@

    playbackStopped

  • @@ -661,7 +661,7 @@

    sessionEnded

  • @@ -723,7 +723,7 @@

    spoken

  • @@ -789,7 +789,7 @@

    start

  • @@ -838,7 +838,7 @@

    stop

  • diff --git a/docs/api/classes/bstalexaevents.html b/docs/api/classes/bstalexaevents.html index 3023681e..656d148f 100644 --- a/docs/api/classes/bstalexaevents.html +++ b/docs/api/classes/bstalexaevents.html @@ -3,7 +3,7 @@ - BSTAlexaEvents | Bespoken Tools + BSTAlexaEvents | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -95,7 +95,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackFinished: string = "AudioPlayer.PlaybackFinished"
    @@ -111,7 +111,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackNearlyFinished: string = "AudioPlayer.PlaybackNearlyFinished"
    @@ -127,7 +127,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackStarted: string = "AudioPlayer.PlaybackStarted"
    @@ -143,7 +143,7 @@

    Static AudioPlayerPlay
    AudioPlayerPlaybackStopped: string = "AudioPlayer.PlaybackStopped"
    @@ -159,7 +159,7 @@

    Static Response

    Response: string = "response"
    diff --git a/docs/api/classes/bstencode.html b/docs/api/classes/bstencode.html index 9ab58e80..5469039c 100644 --- a/docs/api/classes/bstencode.html +++ b/docs/api/classes/bstencode.html @@ -3,7 +3,7 @@ - BSTEncode | Bespoken Tools + BSTEncode | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -115,7 +115,7 @@

    constructor

  • @@ -151,7 +151,7 @@

    encodeFileAndPublish

  • @@ -206,7 +206,7 @@

    encodeFileAndPublishAs

  • @@ -267,7 +267,7 @@

    encodeURLAndPublish

  • @@ -325,7 +325,7 @@

    encodeURLAndPublishAs

  • diff --git a/docs/api/classes/bstproxy.html b/docs/api/classes/bstproxy.html index 0be02258..0b45140f 100644 --- a/docs/api/classes/bstproxy.html +++ b/docs/api/classes/bstproxy.html @@ -3,7 +3,7 @@ - BSTProxy | Bespoken Tools + BSTProxy | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -136,7 +136,7 @@

    constructor

  • Parameters

    @@ -158,7 +158,7 @@

    proxyType

    proxyType: ProxyType.GOOGLE_CLOUD_FUNCTION | ProxyType.HTTP | ProxyType.LAMBDA
    @@ -175,7 +175,7 @@

    activateSecurity

  • @@ -197,7 +197,7 @@

    bespokenServer

  • @@ -228,7 +228,7 @@

    port

  • @@ -258,7 +258,7 @@

    secretKey

  • Parameters

    @@ -281,7 +281,7 @@

    start

  • Parameters

    @@ -322,7 +322,7 @@

    stop

  • Parameters

    @@ -357,7 +357,7 @@

    targetDomain

  • Parameters

    @@ -380,7 +380,7 @@

    Static cloudFunction

  • @@ -411,7 +411,7 @@

    Static http

  • @@ -439,7 +439,7 @@

    Static lambda

  • diff --git a/docs/api/classes/lambdaserver.html b/docs/api/classes/lambdaserver.html index a7b4cf59..7862f01c 100644 --- a/docs/api/classes/lambdaserver.html +++ b/docs/api/classes/lambdaserver.html @@ -3,7 +3,7 @@ - LambdaServer | Bespoken Tools + LambdaServer | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -111,7 +111,7 @@

    constructor

  • @@ -171,7 +171,7 @@

    start

  • @@ -214,7 +214,7 @@

    stop

  • diff --git a/docs/api/classes/log.html b/docs/api/classes/log.html index 7f067ad3..95a68133 100644 --- a/docs/api/classes/log.html +++ b/docs/api/classes/log.html @@ -3,7 +3,7 @@ - Log | Bespoken Tools + Log | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -111,7 +111,7 @@

    constructor

  • Parameters

    @@ -142,7 +142,7 @@

    _timestamp

    _timestamp: Date
    @@ -152,7 +152,7 @@

    data

    data: any
    @@ -162,7 +162,7 @@

    Optional stack

    stack: string
    @@ -172,7 +172,7 @@

    Optional tags

    tags: Array<string>
    @@ -182,7 +182,7 @@

    type

    type: LogType.DEBUG | LogType.ERROR | LogType.INFO | LogType.WARN
    @@ -199,7 +199,7 @@

    timestampAsISOString

  • Returns string

    diff --git a/docs/api/classes/logless.html b/docs/api/classes/logless.html index f5659274..c1071b88 100644 --- a/docs/api/classes/logless.html +++ b/docs/api/classes/logless.html @@ -3,7 +3,7 @@ - Logless | Bespoken Tools + Logless | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -67,7 +67,7 @@

    Class Logless

    Logless will automatically capture logs and diagnostics for your Node.js Lambda, Google Cloud Function or Express.js service.

    -

    Before you integrate the code, you will need to a key. You get it from the Bespoken Dashboard (requires registration/sign-in). +

    Before you integrate the code, you will need to a key. You get it from the Bespoken Dashboard. Once integrated, this is where your logs and data will be viewable.

    To use it with Lambdas, simply wrap your function handler, like so:

    
    @@ -156,7 +156,7 @@ 

    Static Domain

    Domain: string = "logless.bespoken.tools"
    @@ -173,7 +173,7 @@

    Static capture

  • @@ -207,7 +207,7 @@

    Static disableConsoleL
  • Returns void

    @@ -224,7 +224,7 @@

    Static enableConsoleLo
  • @@ -249,7 +249,7 @@

    Static logger

  • @@ -278,7 +278,7 @@

    Static middleware

  • diff --git a/docs/api/classes/loglesscontext.html b/docs/api/classes/loglesscontext.html index d37d6231..d60566bd 100644 --- a/docs/api/classes/loglesscontext.html +++ b/docs/api/classes/loglesscontext.html @@ -3,7 +3,7 @@ - LoglessContext | Bespoken Tools + LoglessContext | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken

  • @@ -112,7 +112,7 @@

    constructor

  • Parameters

    @@ -138,7 +138,7 @@

    callback

  • Returns Function

    @@ -155,7 +155,7 @@

    captureConsole

  • @@ -183,7 +183,7 @@

    cleanup

  • Returns void

    @@ -200,7 +200,7 @@

    flush

  • Parameters

    @@ -235,7 +235,7 @@

    log

  • Parameters

    @@ -267,7 +267,7 @@

    logError

  • Parameters

    @@ -296,7 +296,7 @@

    newTransactionID

  • Returns void

    @@ -313,7 +313,7 @@

    onCloudFunctionEvent

  • Parameters

    @@ -339,7 +339,7 @@

    onLambdaEvent

  • Parameters

    @@ -368,7 +368,7 @@

    transactionID

  • Returns string

    @@ -385,7 +385,7 @@

    transmit

  • Parameters

    @@ -423,7 +423,7 @@

    wrapConsole

  • diff --git a/docs/api/classes/loglessmiddleware.html b/docs/api/classes/loglessmiddleware.html index 7dcc7162..e270c26e 100644 --- a/docs/api/classes/loglessmiddleware.html +++ b/docs/api/classes/loglessmiddleware.html @@ -3,7 +3,7 @@ - LoglessMiddleware | Bespoken Tools + LoglessMiddleware | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -102,7 +102,7 @@

    constructor

  • Parameters

    @@ -127,7 +127,7 @@

    errorHandler

    errorHandler: ExpressErrorHandler
    @@ -137,7 +137,7 @@

    requestHandler

    requestHandler: ExpressRequestHandler
    diff --git a/docs/api/enums/logtype.html b/docs/api/enums/logtype.html index 094f1993..c638830a 100644 --- a/docs/api/enums/logtype.html +++ b/docs/api/enums/logtype.html @@ -3,7 +3,7 @@ - LogType | Bespoken Tools + LogType | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -86,7 +86,7 @@

    DEBUG

    DEBUG:
    @@ -96,7 +96,7 @@

    ERROR

    ERROR:
    @@ -106,7 +106,7 @@

    INFO

    INFO:
    @@ -116,7 +116,7 @@

    WARN

    WARN:
    diff --git a/docs/api/enums/proxytype.html b/docs/api/enums/proxytype.html index be3505a7..acba15b0 100644 --- a/docs/api/enums/proxytype.html +++ b/docs/api/enums/proxytype.html @@ -3,7 +3,7 @@ - ProxyType | Bespoken Tools + ProxyType | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -85,7 +85,7 @@

    GOOGLE_CLOUD_FUNCTION

    GOOGLE_CLOUD_FUNCTION:
    @@ -95,7 +95,7 @@

    HTTP

    HTTP:
    @@ -105,7 +105,7 @@

    LAMBDA

    LAMBDA:
    diff --git a/docs/api/globals.html b/docs/api/globals.html index 1eb1ef9f..b7a987c6 100644 --- a/docs/api/globals.html +++ b/docs/api/globals.html @@ -3,7 +3,7 @@ - Bespoken Tools + Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -52,7 +52,7 @@ Globals

  • -

    Bespoken Tools

    +

    Bespoken

    diff --git a/docs/api/index.html b/docs/api/index.html index ce42a159..1636b322 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -3,7 +3,7 @@ - Bespoken Tools + Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -52,7 +52,7 @@ Globals -

    Bespoken Tools

    +

    Bespoken

    @@ -62,7 +62,7 @@

    Bespoken Tools

    Bespoken Reference API

    Overview

    -

    We currently only expose four primary classes:

    +

    We currently expose five primary classes:

    • BSTAlexa
    • BSTEncode
    • diff --git a/docs/api/interfaces/cloudfunction.html b/docs/api/interfaces/cloudfunction.html index 9d0fb1b9..2dbd683b 100644 --- a/docs/api/interfaces/cloudfunction.html +++ b/docs/api/interfaces/cloudfunction.html @@ -3,7 +3,7 @@ - CloudFunction | Bespoken Tools + CloudFunction | Bespoken @@ -22,7 +22,7 @@
    • Preparing search index...
    • The search index is not available
    - Bespoken Tools + Bespoken
    @@ -79,7 +79,7 @@

    Callable

  • Parameters

    diff --git a/docs/api/interfaces/expresserrorhandler.html b/docs/api/interfaces/expresserrorhandler.html index aa5e6b31..5df4a9c6 100644 --- a/docs/api/interfaces/expresserrorhandler.html +++ b/docs/api/interfaces/expresserrorhandler.html @@ -3,7 +3,7 @@ - ExpressErrorHandler | Bespoken Tools + ExpressErrorHandler | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -79,7 +79,7 @@

    Callable

  • Parameters

    diff --git a/docs/api/interfaces/expressrequesthandler.html b/docs/api/interfaces/expressrequesthandler.html index 51c75349..c9a13902 100644 --- a/docs/api/interfaces/expressrequesthandler.html +++ b/docs/api/interfaces/expressrequesthandler.html @@ -3,7 +3,7 @@ - ExpressRequestHandler | Bespoken Tools + ExpressRequestHandler | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -79,7 +79,7 @@

    Callable

  • Parameters

    diff --git a/docs/api/interfaces/iencoderconfig.html b/docs/api/interfaces/iencoderconfig.html index 980eaa68..5ebc714c 100644 --- a/docs/api/interfaces/iencoderconfig.html +++ b/docs/api/interfaces/iencoderconfig.html @@ -3,7 +3,7 @@ - IEncoderConfig | Bespoken Tools + IEncoderConfig | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -94,7 +94,7 @@

    accessKeyId

    accessKeyId: string
    @@ -109,7 +109,7 @@

    bucket

    bucket: string
    @@ -124,7 +124,7 @@

    Optional filterVolume

    filterVolume: number
    @@ -140,7 +140,7 @@

    secretAccessKey

    secretAccessKey: string
    diff --git a/docs/api/interfaces/lambdafunction.html b/docs/api/interfaces/lambdafunction.html index 4236bd16..3d9e9278 100644 --- a/docs/api/interfaces/lambdafunction.html +++ b/docs/api/interfaces/lambdafunction.html @@ -3,7 +3,7 @@ - LambdaFunction | Bespoken Tools + LambdaFunction | Bespoken @@ -22,7 +22,7 @@
  • Preparing search index...
  • The search index is not available
  • - Bespoken Tools + Bespoken
    @@ -86,7 +86,7 @@

    Callable

  • diff --git a/docs/index.md b/docs/index.md index a20c8d56..1ab03688 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,8 +38,6 @@ With Bespoken, develop faster and better. Do not slow-down for: * Over-complicated and highly manual testing routines * Complex ffmpeg encoding and configuration -With Bespoken, build high-quality, faster. - The command-line tools include: * [Deploy](http://docs.bespoken.tools/en/latest/commands/deploy) - One-command deployment of Lambda functions diff --git a/lib/logless/logless.ts b/lib/logless/logless.ts index 4596e21d..26df1ddf 100644 --- a/lib/logless/logless.ts +++ b/lib/logless/logless.ts @@ -4,7 +4,7 @@ import {LogType} from "./logless-context"; /** * Logless will automatically capture logs and diagnostics for your Node.js Lambda, Google Cloud Function or Express.js service. * - * Before you integrate the code, you will need to a key. You get it from [the Bespoken Dashboard](https://apps.bespoken.io/dashboard) (requires registration/sign-in). + * Before you integrate the code, you will need to a key. You get it from [the Bespoken Dashboard](https://apps.bespoken.io/dashboard). * Once integrated, this is where your logs and data will be viewable. * * To use it with Lambdas, simply wrap your function handler, like so: