From 00c68aea74cfd4f0a9240ca4f5d382cbe1af1107 Mon Sep 17 00:00:00 2001 From: hiento09 <136591877+hiento09@users.noreply.github.com> Date: Thu, 23 Nov 2023 14:56:05 +0700 Subject: [PATCH] Fix error docs pipeline run failed (#702) Co-authored-by: Hien To --- .github/workflows/jan-docs.yml | 2 +- docs/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/jan-docs.yml b/.github/workflows/jan-docs.yml index e0b496b35..bc8473687 100644 --- a/.github/workflows/jan-docs.yml +++ b/.github/workflows/jan-docs.yml @@ -24,7 +24,7 @@ jobs: CLOUDFLARE_PROJECT_NAME: jan runs-on: ubuntu-latest permissions: - contents: read + contents: write deployments: write pull-requests: write steps: diff --git a/docs/README.md b/docs/README.md index 9baac2b29..63d21064b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -43,9 +43,9 @@ If you are using GitHub pages for hosting, this command is a convenient way to b ### Preview URL, Pre-release and Publishing Documentation -When a PR is created, the preview URL will be automatically commented on the PR. For staging or pre-release documentation, use the following domains [https://pre-release.jan.ai/](https://pre-release.jan.ai/) +When a PR is created, the preview URL will be automatically commented on the PR. -To officially publish documentation, create a tag in the format `vx.y.z-docs` (e.g., `v0.1.1-docs`) on the `main` branch. The documentation will then be published to [https://jan.ai/](https://jan.ai/) +The documentation will then be published to [https://jan.ai/](https://jan.ai/) when the PR is merged to `main`. ### Additional Plugins - @docusaurus/theme-live-codeblock