Updating documentation

FastyBird · Feb 26, 2024 · 22e4c1b · 22e4c1b
1 parent cc4c92d
commit 22e4c1b
Show file tree

Hide file tree

Showing 9 changed files with 117 additions and 948 deletions.
diff --git a/.editorconfig b/.editorconfig
diff --git a/src/FastyBird/Plugin/WebServer/.github/workflows/wiki.yml b/src/FastyBird/Plugin/WebServer/.github/workflows/wiki.yml
@@ -0,0 +1,22 @@
+name: "wiki"
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  deploy:
+    name: "Deploy docs to wiki"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+
+      - name: "Deploy to Wiki"
+        uses: "SwiftDocOrg/github-wiki-publish-action@v1"
+        with:
+          path: "docs"
+        env:
+          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
diff --git a/src/FastyBird/Plugin/WebServer/README.md b/src/FastyBird/Plugin/WebServer/README.md
@@ -41,8 +41,7 @@ composer require fastybird/web-server-plugin
 
 ## Documentation
 
-Learn how to build and handle http api requests
-in [documentation](https://github.com/FastyBird/web-server-plugin/blob/main/docs/index.md).
+:book: Learn how to build and handle http api requests in [documentation](https://github.com/FastyBird/web-server-plugin/wiki).
 
 # FastyBird
 
@@ -54,7 +53,7 @@ FastyBird is an Open Source IOT solution built from decoupled components with po
 
 ## Documentation
 
-Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).
+:book: Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).
 
 ## Contributing
 

diff --git a/src/FastyBird/Plugin/WebServer/docs/index.md → src/FastyBird/Plugin/WebServer/docs/Home.md b/src/FastyBird/Plugin/WebServer/docs/index.md → src/FastyBird/Plugin/WebServer/docs/Home.md
@@ -1,23 +1,32 @@
-# Quick start
+<p align="center">
+	<img src="https://github.com/fastybird/.github/blob/main/assets/repo_title.png?raw=true" alt="FastyBird"/>
+</p>
 
-The purpose of this plugin is to create php based web server for serving and handling API request and responses.
+> [!IMPORTANT]
+This documentation is meant to be used by developers or users which has basic programming skills. If you are regular user
+please use FastyBird IoT documentation which is available on [docs.fastybird.com](https://docs.fastybird.com).
 
-***
+# About Plugin
 
-## Installation
+The purpose of this plugin is to create php based web server for serving and handling API request and responses.
 
-The best way to install **fastybird/web-server-plugin** is using [Composer](http://getcomposer.org/):
+This library has some services divided into namespaces. All services are preconfigured and imported into application
+container automatically.
 
-```sh
-composer require fastybird/web-server-plugin
+```
+\FastyBird\Plugin\RedisDb
+  \Commands - Console commands to run WS server
+  \Events - Events which are triggered by plugin and other services
+  \Middleware - Server basic middlewares
+  \Subscribers - Plugin subscribers which are subscribed to main sockets library
 ```
 
-After that, you have to register plugin in *config.neon*.
+All services, helpers, etc. are written to be self-descriptive :wink:.
 
-```neon
-extensions:
-    fbWebServerPlugin: FastyBird\Plugin\WebServer\DI\WebServerExtension(%consoleMode%)
-```
+## Using Plugin
+
+The plugin is ready to be used as is. Has configured all services in application container and there is no need to develop
+some other services or bridges.
 
 This plugin is dependent on other extensions, and they have to be registered too
 
@@ -28,9 +37,7 @@ extensions:
     contributteEvents: Contributte\EventDispatcher\DI\EventDispatcherExtension
 ```
 
-> For information how to configure these extensions please visit their doc pages
-
-## Configuration
+## Plugin Configuration
 
 This plugin has some configuration options:
 
@@ -246,7 +253,3 @@ your responses and document to entity hydrator
 
 And last but not least, [fastybird/simple-auth](https://github.com/FastyBird/simple-auth). With this package you could
 create basic token based authentication and authorization.
-
-***
-Homepage [https://www.fastybird.com](https://www.fastybird.com) and
-repository [https://github.com/FastyBird/web-server-pluging](https://github.com/FastyBird/web-server-plugin).
diff --git a/src/FastyBird/Plugin/WebServer/docs/_Footer.md b/src/FastyBird/Plugin/WebServer/docs/_Footer.md
@@ -0,0 +1,8 @@
+> [!TIP]
+If you find incorrect or missing information, feel free to notify us. You could use the [issue tracker](https://github.com/FastyBird/fastybird/issues)
+or [mail](mailto:code@fastybird.com) or [X network](https://x.com/fastybird) for any idea that can improve the project.
+Thank you for testing, reporting and contributing.
+
+***
+Homepage [https://www.fastybird.com](https://www.fastybird.com) and
+repository [https://github.com/fastybird/web-server-plugin](https://github.com/fastybird/web-server-plugin).
diff --git a/src/FastyBird/Plugin/WsServer/.github/workflows/wiki.yml b/src/FastyBird/Plugin/WsServer/.github/workflows/wiki.yml
@@ -0,0 +1,22 @@
+name: "wiki"
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  deploy:
+    name: "Deploy docs to wiki"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+
+      - name: "Deploy to Wiki"
+        uses: "SwiftDocOrg/github-wiki-publish-action@v1"
+        with:
+          path: "docs"
+        env:
+          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
diff --git a/src/FastyBird/Plugin/WsServer/README.md b/src/FastyBird/Plugin/WsServer/README.md
@@ -39,7 +39,7 @@ composer require fastybird/ws-server-plugin
 
 ## Documentation
 
-Learn how to start server, consume & call RPC messages in [documentation](https://github.com/FastyBird/ws-server-plugin/blob/main/docs/index.md).
+:book: Learn how to start server, consume & call RPC messages in [documentation](https://github.com/FastyBird/ws-server-plugin/wiki).
 
 # FastyBird
 
@@ -51,7 +51,7 @@ FastyBird is an Open Source IOT solution built from decoupled components with po
 
 ## Documentation
 
-Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).
+:book: Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).
 
 ## Contributing
 

diff --git a/src/FastyBird/Plugin/WsServer/docs/index.md → src/FastyBird/Plugin/WsServer/docs/Home.md b/src/FastyBird/Plugin/WsServer/docs/index.md → src/FastyBird/Plugin/WsServer/docs/Home.md
@@ -1,23 +1,31 @@
-# Quick start
+<p align="center">
+	<img src="https://github.com/fastybird/.github/blob/main/assets/repo_title.png?raw=true" alt="FastyBird"/>
+</p>
 
-The purpose of this plugin is to create php based WS server for serving and handling sockets real time connections.
+> [!IMPORTANT]
+This documentation is meant to be used by developers or users which has basic programming skills. If you are regular user
+please use FastyBird IoT documentation which is available on [docs.fastybird.com](https://docs.fastybird.com).
 
-***
+# About Plugin
 
-## Installation
+The purpose of this plugin is to create php based WS server for serving and handling sockets real time connections.
 
-The best way to install **fastybird/ws-server-plugin** is using [Composer](http://getcomposer.org/):
+This library has some services divided into namespaces. All services are preconfigured and imported into application
+container automatically.
 
-```sh
-composer require fastybird/ws-server-plugin
+```
+\FastyBird\Plugin\RedisDb
+  \Commands - Console commands to run WS server
+  \Events - Events which are triggered by plugin and other services
+  \Subscribers - Plugin subscribers which are subscribed to main sockets library
 ```
 
-After that, you have to register plugin in *config.neon*.
+All services, helpers, etc. are written to be self-descriptive :wink:.
 
-```neon
-extensions:
-    fbWsServerPlugin: FastyBird\Plugin\WsServer\DI\WsServerExtension
-```
+## Using Plugin
+
+The plugin is ready to be used as is. Has configured all services in application container and there is no need to develop
+some other services or bridges.
 
 This plugin is dependent on other extensions, and they have to be registered too
 
@@ -29,9 +37,7 @@ extensions:
     ipubWebsocketsWamp: IPub\WebSocketsWAMP\DI\WebSocketsWAMPExtension
 ```
 
-> For information how to configure these extensions please visit their doc pages
-
-## Configuration
+## Plugin Configuration
 
 This plugin has some configuration options:
 
@@ -54,7 +60,3 @@ This plugin has implemented command interface for running server. All you have t
 ```sh
 <app_root>/vendor/bin/fb-console fb:ws-server:start
 ```
-
-***
-Homepage [https://www.fastybird.com](https://www.fastybird.com) and
-repository [https://github.com/FastyBird/ws-server-pluging](https://github.com/FastyBird/ws-server-plugin).
diff --git a/src/FastyBird/Plugin/WsServer/docs/_Footer.md b/src/FastyBird/Plugin/WsServer/docs/_Footer.md
@@ -0,0 +1,8 @@
+> [!TIP]
+If you find incorrect or missing information, feel free to notify us. You could use the [issue tracker](https://github.com/FastyBird/fastybird/issues)
+or [mail](mailto:code@fastybird.com) or [X network](https://x.com/fastybird) for any idea that can improve the project.
+Thank you for testing, reporting and contributing.
+
+***
+Homepage [https://www.fastybird.com](https://www.fastybird.com) and
+repository [https://github.com/fastybird/ws-server-plugin](https://github.com/fastybird/ws-server-plugin).