Deploy docs workflow & fix some docs

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Deploy docs
+
+on:
+  pull_request:
+    branches: [ main ]
+    types: [ closed ]
+    paths:
+      - "docs/**"
+
+jobs:
+  trigger_docs_website_deploy:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          # Checkout the merge commit on the base branch
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+
+      - name: Trigger website deploy
+        env:
+          DOCS_REPO_TOKEN: ${{ secrets.DOCS_REPO_TOKEN }}
+        run: |
+          set -euo pipefail
+          curl -sS -L --fail-with-body \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${DOCS_REPO_TOKEN}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            https://api.github.com/repos/ozontech/seq-db-docs/dispatches \
+            -d '{"event_type":"dispatch-event"}'

README.md

@@ -17,7 +17,7 @@ Get started quickly by following our [Quickstart Guide](/docs/en/01-quickstart.m
 
 ## Configuring
 
-The application can be configured via yaml file. See the details in [Config documentation](/docs/en/02-config.md).
+The application can be configured via yaml file. See the details in [Config documentation](/docs/en/02-configuration.md).
 
 Examples of config file can be found [here](/config).
 

docs/en/01-quickstart.md

@@ -55,6 +55,6 @@ curl -X POST \
 ## What's next
 
 seq-ui offers many more useful features for working with logs and users:
-- [Seq API](https://github.com/ozontech/seq-ui/blob/main/docs/en/03-seq-api.md) provides access to logs, aggregations and histogram
-- [UserProfile API](https://github.com/ozontech/seq-ui/blob/main/docs/en/04-userprofile-api.md) provides the ability to manage users and their data
-- [Dashboards API](https://github.com/ozontech/seq-ui/blob/main/docs/en/05-dashboards-api.md) provides the ability to combine a search query, aggregations and a histogram in a dashboard and save it to DB
+- [Seq API](./03-seq-api.md) provides access to logs, aggregations and histogram
+- [UserProfile API](./04-userprofile-api.md) provides the ability to manage users and their data
+- [Dashboards API](./05-dashboards-api.md) provides the ability to combine a search query, aggregations and a histogram in a dashboard and save it to DB

docs/en/02-config.md → docs/en/02-configuration.md

@@ -1,4 +1,6 @@
-# Config
+# Configuration
+
+> Despite the fact that there are a huge number of parameters in the configuration, not all of them are supported by UI at the moment. As the UI evolves, more and more of the parameters will be relevant.
 
 The configuration is set via a yaml file and consists of three sections:
 - [server](#server) - seq-ui server configutarion

docs/en/03-seq-api.md

@@ -450,7 +450,7 @@ curl -X POST \
 
 ### `GET /fields/pinned`
 
-Returns the list of fields that will be pinned in UI. Set in the `handlers.seq_api.pinned_fields` [config section](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md#seqapi).
+Returns the list of fields that will be pinned in UI. Set in the `handlers.seq_api.pinned_fields` [config section](./02-configuration.md#seqapi).
 
 **Auth:** NO
 
@@ -481,7 +481,7 @@ curl -X GET \
 
 ### `GET /limits`
 
-Returns the list of limits set in the `handlers.seq_api` [config section](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md#seqapi).
+Returns the list of limits set in the `handlers.seq_api` [config section](./02-configuration.md#seqapi).
 
 **Auth:** NO
 

docs/en/04-userprofile-api.md

@@ -2,7 +2,7 @@
 
 UserProfile API provides the ability to manage users and their data.
 
-**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md).**
+**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](./02-configuration.md).**
 
 ## HTTP API
 

docs/en/05-dashboards-api.md

@@ -8,7 +8,7 @@ The dashboard consists of:
 - widgets: aggregations and a histogram
 - list of pinned table columns
 
-**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md).**
+**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](./02-configuration.md).**
 
 ## HTTP API
 

docs/ru/01-quickstart.md

@@ -55,6 +55,6 @@ curl -X POST \
 ## What's next
 
 seq-ui offers many more useful features for working with logs and users:
-- [Seq API](https://github.com/ozontech/seq-ui/blob/main/docs/en/03-seq-api.md) provides access to logs, aggregations and histogram
-- [UserProfile API](https://github.com/ozontech/seq-ui/blob/main/docs/en/04-userprofile-api.md) provides the ability to manage users and their data
-- [Dashboards API](https://github.com/ozontech/seq-ui/blob/main/docs/en/05-dashboards-api.md) provides the ability to combine a search query, aggregations and a histogram in a dashboard and save it to DB
+- [Seq API](./03-seq-api.md) provides access to logs, aggregations and histogram
+- [UserProfile API](./04-userprofile-api.md) provides the ability to manage users and their data
+- [Dashboards API](./05-dashboards-api.md) provides the ability to combine a search query, aggregations and a histogram in a dashboard and save it to DB

docs/ru/02-config.md → docs/ru/02-configuration.md

@@ -1,4 +1,6 @@
-# Config
+# Configuration
+
+> Despite the fact that there are a huge number of parameters in the configuration, not all of them are supported by UI at the moment. As the UI evolves, more and more of the parameters will be relevant.
 
 The configuration is set via a yaml file and consists of three sections:
 - [server](#server) - seq-ui server configutarion

docs/ru/03-seq-api.md

@@ -450,7 +450,7 @@ curl -X POST \
 
 ### `GET /fields/pinned`
 
-Returns the list of fields that will be pinned in UI. Set in the `handlers.seq_api.pinned_fields` [config section](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md#seqapi).
+Returns the list of fields that will be pinned in UI. Set in the `handlers.seq_api.pinned_fields` [config section](./02-configuration.md#seqapi).
 
 **Auth:** NO
 
@@ -481,7 +481,7 @@ curl -X GET \
 
 ### `GET /limits`
 
-Returns the list of limits set in the `handlers.seq_api` [config section](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md#seqapi).
+Returns the list of limits set in the `handlers.seq_api` [config section](./02-configuration.md#seqapi).
 
 **Auth:** NO
 

docs/ru/04-userprofile-api.md

@@ -2,7 +2,7 @@
 
 UserProfile API provides the ability to manage users and their data.
 
-**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md).**
+**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](./02-configuration.md).**
 
 ## HTTP API
 

docs/ru/05-dashboards-api.md

@@ -8,7 +8,7 @@ The dashboard consists of:
 - widgets: aggregations and a histogram
 - list of pinned table columns
 
-**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](https://github.com/ozontech/seq-ui/blob/main/docs/en/02-config.md).**
+**The API requires a PostgreSQL DB and Authorization to work, which must be specified in [config](./02-configuration.md).**
 
 ## HTTP API