From 5eab134fcb5282eb4bb92518404f0d53c69c4552 Mon Sep 17 00:00:00 2001 From: Chris O'Neil Date: Fri, 3 Jan 2025 17:40:21 +0000 Subject: [PATCH] chore: publish docs on merge We don't need to publish the documentation as part of the PR; it can be done after we merge. The `GH_TOKEN` variable is also set to a personal access token that should have permission to push to the repository. There is a small change in the documentation that removes a typo. It was used to test the process. --- .github/workflows/docs.yml | 8 +++----- docs/online-documentation/index.md | 2 +- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a0766bc24d..5519917491 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,16 +3,14 @@ on: push: branches: - main - - data_further_refactor - pull_request: - branches: - - main permissions: contents: write jobs: deploy: + env: + GH_TOKEN: ${{ secrets.AUTONOMI_PAT }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -33,4 +31,4 @@ jobs: run: | git config --global user.name "github-actions" git config --global user.email "github-actions@github.com" - mkdocs gh-deploy --force \ No newline at end of file + mkdocs gh-deploy --force diff --git a/docs/online-documentation/index.md b/docs/online-documentation/index.md index 2690d09b19..05062bdd30 100644 --- a/docs/online-documentation/index.md +++ b/docs/online-documentation/index.md @@ -13,7 +13,7 @@ Autonomi is a decentralised data and communications platform designed to provide - [Data Types](guides/data_types.md) - Understanding the fundamental data structures - [Client Modes](guides/client_modes.md) - Different operational modes of the client - [Data Storage](guides/data_storage.md) - How data is stored and retrieved - - [Local Network Setup](guides/local_network.md) - Setting up a local development environmentv + - [Local Network Setup](guides/local_network.md) - Setting up a local development environment ### API References