From 1dc5639fd5851c11139de48283f838b8de347093 Mon Sep 17 00:00:00 2001 From: Rodrigo Rodriguez Date: Mon, 4 Mar 2019 09:40:50 -0300 Subject: [PATCH] chore(docs): New file names and introduction for some chapters. --- ...hapter-01-Index.md => chapter-01-index.md} | 54 ++++++++++--------- ...nce.md => chapter-02-the-package-based.md} | 15 +++++- ...erence.md => chapter-03-gbkb-reference.md} | 0 ...nce.md => chapter-04-gbtheme-reference.md} | 0 ...ce.md => chapter-05-gbdialog-reference.md} | 0 ...rence.md => chapter-06-gbapp-reference.md} | 15 ++++++ ...ration.md => chapter-07-administration.md} | 4 ++ book/chapter-08-Tooling.md | 5 -- book/chapter-08-tooling.md | 19 +++++++ ...-09-Services.md => chapter-09-ux-in-va.md} | 0 ...ributing.md => chapter-10-contributing.md} | 0 11 files changed, 82 insertions(+), 30 deletions(-) rename book/{chapter-01-Index.md => chapter-01-index.md} (52%) rename book/{chapter-02-Package Reference.md => chapter-02-the-package-based.md} (69%) rename book/{chapter-03-.gbkb reference.md => chapter-03-gbkb-reference.md} (100%) rename book/{chapter-04-.gbtheme reference.md => chapter-04-gbtheme-reference.md} (100%) rename book/{chapter-05-.gbdialog reference.md => chapter-05-gbdialog-reference.md} (100%) rename book/{chapter-06-.gbapp reference.md => chapter-06-gbapp-reference.md} (91%) rename book/{chapter-07-Administration.md => chapter-07-administration.md} (97%) delete mode 100644 book/chapter-08-Tooling.md create mode 100644 book/chapter-08-tooling.md rename book/{chapter-09-Services.md => chapter-09-ux-in-va.md} (100%) rename book/{chapter-10-Contributing.md => chapter-10-contributing.md} (100%) diff --git a/book/chapter-01-Index.md b/book/chapter-01-index.md similarity index 52% rename from book/chapter-01-Index.md rename to book/chapter-01-index.md index 75be2a32..162f1490 100644 --- a/book/chapter-01-Index.md +++ b/book/chapter-01-index.md @@ -1,10 +1,26 @@ -# General Bots Book +# General Bots - The Bot Server -## Package Quick Reference +Welcome to the General Bots Book. This is a reference material that can be used +to understand how the bot server is organized in a form of packages itself and +this arrangement can be used to all custom deployed packages like .gbkb, .gbtheme +or .gbapp. +This book is organized in ten chapters that can be accessed throuhg this table bellow: -|Whatsapp|Web|Core|KB| -|----|-----|----|----| -|[whatsapp.gblib](https://github.com/pragmatismo-io/BotServer/tree/master/packages/whatsapp.gblib)|[default.gbui](https://github.com/pragmatismo-io/BotServer/tree/master/packages/default.gbui)|[core.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/core.gbapp)|[kb.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/kb.gbapp)| +* [Acknowledgments](acknowledgments.md) +* [Chapter 01 - The Bot Server ](chapter-01-index.md) +* [Chapter 02 - About Packages](chapter-02-about-packages.md) +* [Chapter 03 - gbkb Reference](chapter-03-gbkb-reference.md) +* [Chapter 04 - gbtheme Reference](chapter-04-gbtheme-reference.md) +* [Chapter 05 - gbdialog Reference](chapter-05-gbdialog-reference.md) +* [Chapter 06 - gbapp Reference](chapter-06-gbappreference.md) +* [Chapter 07 - Administration](chapter-07-administration.md) +* [Chapter 08 - Tooling](chapter-08-tooling.md) +* [Chapter 09 - Services](chapter-09-services.md) +* [Chapter 10 - Contributing](chapter-10-contributing.md) +* [Copyright](copyright.md) +* [Foreward](foreward.md) +* [Glossary](glossary.md) +* [Preface](preface.md) ### The bot development stack @@ -39,24 +55,14 @@ Notes: 1. [Download](https://codeload.github.com/pragmatismo-io/BotServer/zip/master) the Zip file. +## NLP -## Trainning Topics +## Spell Checker -* Clone BotServer, BotLib repository -* Keyboard centric -* WIN: micro.exe -* Launcher -* dir/ls/ll, cd, mkdir, move -* Npm run build -* npm update -g -* node -v -* SHIFT+PAGE DOWN/UP on Terminal Window -* ncu -a Update all packages in package.json -* npm update -g All NPM package on the system -* Introduction to General Bo -* Environment setup and get the server runni -* KB loading -* NLP and toolin -* Find a NPM package to create a .gbapp that asks for data and output the result -* Visual Studio Code Insiders and plugins -* Run Build Task tsc:watch +## Speech to Text + +## Omnichannel + +## Branding + +## Bot Factory diff --git a/book/chapter-02-Package Reference.md b/book/chapter-02-the-package-based.md similarity index 69% rename from book/chapter-02-Package Reference.md rename to book/chapter-02-the-package-based.md index d575c1fb..065efaff 100644 --- a/book/chapter-02-Package Reference.md +++ b/book/chapter-02-the-package-based.md @@ -1,4 +1,11 @@ -# General Bots Packages Reference +# About Packages + +Packages can be stored as folders in the file system, synced with cloud storages and +content management systems like SharePoint and even sent like .zip files on a e-mail. +Just to increse bot knowledge, intelligence and how they look to us. So working on a +General Bots project is like to split the work on several packages if needed and work +on a package at once or even share the work with collegues, agencies or development +companies to more advanced package building. ## How To @@ -67,3 +74,9 @@ A set of subjects that bot knows in a form of hierarchical menu-based QnA. [A sa ### .gblib Shared code that can be used across bot apps. + +## System Package Quick Reference + +|Whatsapp|Web|Core|KB| +|----|-----|----|----| +|[whatsapp.gblib](https://github.com/pragmatismo-io/BotServer/tree/master/packages/whatsapp.gblib)|[default.gbui](https://github.com/pragmatismo-io/BotServer/tree/master/packages/default.gbui)|[core.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/core.gbapp)|[kb.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/kb.gbapp)| diff --git a/book/chapter-03-.gbkb reference.md b/book/chapter-03-gbkb-reference.md similarity index 100% rename from book/chapter-03-.gbkb reference.md rename to book/chapter-03-gbkb-reference.md diff --git a/book/chapter-04-.gbtheme reference.md b/book/chapter-04-gbtheme-reference.md similarity index 100% rename from book/chapter-04-.gbtheme reference.md rename to book/chapter-04-gbtheme-reference.md diff --git a/book/chapter-05-.gbdialog reference.md b/book/chapter-05-gbdialog-reference.md similarity index 100% rename from book/chapter-05-.gbdialog reference.md rename to book/chapter-05-gbdialog-reference.md diff --git a/book/chapter-06-.gbapp reference.md b/book/chapter-06-gbapp-reference.md similarity index 91% rename from book/chapter-06-.gbapp reference.md rename to book/chapter-06-gbapp-reference.md index 38b00eb7..afccf543 100644 --- a/book/chapter-06-.gbapp reference.md +++ b/book/chapter-06-gbapp-reference.md @@ -8,6 +8,13 @@ like a TypeScript application. This conversational application will contain the source code for custom dialogs and behaviour for any .gbot that associate this deployed .gbapp. +A good way to start a .gbapp is to find a NPM package to create a .gbapp that +asks for data and output the result. For example, a temperature package can +be installed via `npm install temperature` and then have its methods +convertToKelvin or convertToCelsius called when user asks for conversion. A +.gbapp can persist and read data from database according to the conversation +session. + ## Preparing Environment ### Windows @@ -138,3 +145,11 @@ static getDialogs(bot: BotAdapter, min: GBMinInstance) { | mikestead.dotenv | Description here | | sirtori.indenticator | Description here | | tandy.color-basic | Description here | + +## Common tasks + +| Task | Description | +|---------------|-------------------------------------| +| npm update -g | Updates NPM | +| node -v | Checks node version | +| ncu -a | Update all packages in package.json | diff --git a/book/chapter-07-Administration.md b/book/chapter-07-administration.md similarity index 97% rename from book/chapter-07-Administration.md rename to book/chapter-07-administration.md index 6bf82ede..fa8ff73f 100644 --- a/book/chapter-07-Administration.md +++ b/book/chapter-07-administration.md @@ -23,3 +23,7 @@ Discontinued commands: ### Move to production (Azure) * Update bot endpoint; + +## Bot Analytics + +## Cloud Internals \ No newline at end of file diff --git a/book/chapter-08-Tooling.md b/book/chapter-08-Tooling.md deleted file mode 100644 index 453a4b67..00000000 --- a/book/chapter-08-Tooling.md +++ /dev/null @@ -1,5 +0,0 @@ - - -## Quality Assurance - -https://codecept.io/nightmare \ No newline at end of file diff --git a/book/chapter-08-tooling.md b/book/chapter-08-tooling.md new file mode 100644 index 00000000..35a7d018 --- /dev/null +++ b/book/chapter-08-tooling.md @@ -0,0 +1,19 @@ +# General Bots Tooling + +## NLP + +### luis.ai + +## Spell Checker + +### Bing Spell Checker + +## Speech to Text + +### Azure Speech Services + +## Quality Assurance + +### Nightmare + +https://codecept.io/nightmare diff --git a/book/chapter-09-Services.md b/book/chapter-09-ux-in-va.md similarity index 100% rename from book/chapter-09-Services.md rename to book/chapter-09-ux-in-va.md diff --git a/book/chapter-10-Contributing.md b/book/chapter-10-contributing.md similarity index 100% rename from book/chapter-10-Contributing.md rename to book/chapter-10-contributing.md