Skip to content

Commit

Permalink
new(all): Site for the Reference and API.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rodrigo Rodriguez committed Aug 26, 2024
1 parent 24df605 commit 707d2d9
Show file tree
Hide file tree
Showing 46 changed files with 155 additions and 877 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
swa-cli.config.json
deploy.sh
site/build
site/.docusaurus
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1 @@
# General Bots - The Bot Server

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:

* [Acknowledgments](book/acknowledgments.md)
* [Chapter 01 - Run and Talk](book/chapter-01-run-and-talk.md)
* [Chapter 02 - About Packages](book/chapter-02-the-package-based.md)
* [Chapter 03 - gbkb Reference](book/chapter-03-gbkb-reference.md)
* [Chapter 04 - gbtheme Reference](book/chapter-04-gbtheme-reference.md)
* [Chapter 05 - gbdialog Reference](book/chapter-05-gbdialog-reference.md)
* [Chapter 06 - gbapp Reference](book/chapter-06-gbapp-reference.md)
* [Chapter 07 - gbot Reference](book/chapter-07-gbot-reference.md)
* [Chapter 08 - Tooling](book/chapter-08-tooling.md)
* [Chapter 09 - Services](book/chapter-09-services.md)
* [Chapter 10 - Contributing](book/chapter-10-contributing.md)
* [Apendix I - Database Model](book/apendix-i-database-model.md)
* [Copyright](book/copyright.md)
* [Foreward](book/foreward.md)
* [Glossary](book/glossary.md)
* [Preface](book/preface.md)

8 changes: 0 additions & 8 deletions _config.yml

This file was deleted.

12 changes: 0 additions & 12 deletions site/blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions site/blog/2019-05-29-long-blog-post.md

This file was deleted.

24 changes: 0 additions & 24 deletions site/blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
29 changes: 0 additions & 29 deletions site/blog/2021-08-26-welcome/index.md

This file was deleted.

23 changes: 0 additions & 23 deletions site/blog/authors.yml

This file was deleted.

19 changes: 0 additions & 19 deletions site/blog/tags.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Apendix I - General Bots Database Model
---
sidebar_position: 1000
---

# Apendix I - Database Model

The database model can be seen on the picture bellow. In each .gbapp or .gblib
the folder **Model** will contain the Sequelize definition for each one of these
tables and their relationship.

![General Bots Database Model](../images/GeneralBotsDatabaseModel.png)
![General Bots Database Model](./images/GeneralBotsDatabaseModel.png)
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Apendix II - General Bots Network Diagrams
---
sidebar_position: 1000
---

# Apendix II - Network Diagrams

## Reverse Proxy for Development

When establishing a local development machine, an user can use the ngrok based proxy. The diagram shows how the localhost becomes accesible when the Bot Service need to connect, routing messages from the cloud to the local development server machine.

![General Bots Reverse Proxy](../images/GeneralBotsReverseProxy.png)
![General Bots Reverse Proxy](./images/GeneralBotsReverseProxy.png)
16 changes: 0 additions & 16 deletions site/docs/book/acknowledgments.md

This file was deleted.

33 changes: 0 additions & 33 deletions site/docs/book/chapter-08-tooling.md

This file was deleted.

Empty file.
22 changes: 0 additions & 22 deletions site/docs/book/copyright.md

This file was deleted.

Binary file removed site/docs/book/cover.png
Binary file not shown.
3 changes: 0 additions & 3 deletions site/docs/book/foreward.md

This file was deleted.

43 changes: 0 additions & 43 deletions site/docs/book/metadata.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions site/docs/book/preface.md

This file was deleted.

22 changes: 0 additions & 22 deletions site/docs/book/references.yaml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# General Bots - Run and Talk to the Bot
---
sidebar_position: 10
---

# Run and Talk

### Bot Development Stack

Expand Down Expand Up @@ -33,10 +37,6 @@ GeneralBots aims to deliver bots on Azure in an easy and efficient manner. Utili
3. Type `npm install -g botserver` and press **ENTER**.
4. Type `gbot` to start the server core.

## Installation via PowerShell or Command Prompt

![Installation via npm](https://user-images.githubusercontent.com/65977273/94572520-81e2f380-0247-11eb-9d69-ff70ad26b027.png)

### Notes:

- [*nodejs.install* Chocolatey Package](https://chocolatey.org/packages/nodejs.install) is also available (Chocolatey is a Windows package manager).
Expand Down
Loading

0 comments on commit 707d2d9

Please sign in to comment.