diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml new file mode 100644 index 0000000..8799804 --- /dev/null +++ b/.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/README.md b/README.md index 23fd0ad..d2579e7 100644 --- a/README.md +++ b/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/docs/index.md b/docs/Home.md similarity index 86% rename from docs/index.md rename to docs/Home.md index 50511dd..f41e55a 100644 --- a/docs/index.md +++ b/docs/Home.md @@ -1,23 +1,32 @@ -# Quick start +

+ FastyBird +

-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/docs/_Footer.md b/docs/_Footer.md new file mode 100644 index 0000000..e229547 --- /dev/null +++ b/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).