diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..67371095 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ +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: + - uses: actions/checkout@v5 + with: + # Check out the merge commit on the base branch + ref: ${{ github.event.pull_request.merge_commit_sha }} + - name: Send trigger for remote 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"}' \ No newline at end of file diff --git a/docs/en/01-quickstart.md b/docs/en/01-quickstart.md index f8847548..cf72fc43 100644 --- a/docs/en/01-quickstart.md +++ b/docs/en/01-quickstart.md @@ -15,7 +15,7 @@ Welcome to the seq-db quickstart guide! In just a few minutes, you'll learn how ### Single node mode -Before launch you need to create config file: +Before launch you need to create a config file: config.yaml: diff --git a/docs/en/05-seq-ql.md b/docs/en/05-seq-ql.md index 3a74da83..c101d021 100644 --- a/docs/en/05-seq-ql.md +++ b/docs/en/05-seq-ql.md @@ -84,7 +84,7 @@ The language supports the following symbols: - `*` — replaces any number of characters. These symbols can be used to search within tokens or parts of tokens. -For example, a query on the [keyword](03-index-types.md#keyword) index `source_type:access*` will match all documents starting +For example, a query on the [keyword](03-index-types.md) index `source_type:access*` will match all documents starting with `access`. ## Filter `range` diff --git a/docs/en/12-architecture.md b/docs/en/13-architecture.md similarity index 98% rename from docs/en/12-architecture.md rename to docs/en/13-architecture.md index e1bb5a3b..cd59e81b 100644 --- a/docs/en/12-architecture.md +++ b/docs/en/13-architecture.md @@ -32,7 +32,7 @@ Because the dataset is stored in these three file types, moving or restoring a shard is straightforward: simply `cp` / `rsync` the directory to the target node and start the pod. -Read more about file types and their internal structure [here](./internal/fractions.md). +Read more about file types and their internal structure [here](internal/fractions.md). #### Durability A write operation is acknowledged only after the payload is safely persisted: