From cec41dc3662701dd631e354dd4aed1d711ae7ec1 Mon Sep 17 00:00:00 2001 From: Ewen Quimerc'h <46993939+EwenQuim@users.noreply.github.com> Date: Thu, 25 Jan 2024 09:22:10 +0100 Subject: [PATCH] Deploy docusaurus to github pages (#38) * Uses npm instead of pnpm * Trigger on pull request * Remove path modification requirement * Remove dead links * Triggers deployment --- .github/workflows/pages.yml | 13 ++++++------- documentation/docs/examples/congratulations.md | 4 +--- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 538f6f74..50eef081 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -3,9 +3,11 @@ name: Deploy Docusaurus site to Pages on: # Runs on pushes targeting the default branch push: - branches: ["main"] + branches: ["main", "ci/**"] paths: - "documentation/**" + pull_request: + branches: ["main", "ci/**"] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -33,17 +35,14 @@ jobs: uses: actions/setup-node@v4 with: node-version: "18" - cache: "pnpm" - - - name: Install pnpm - run: npm install -g pnpm + - name: Install dependencies - run: pnpm install + run: npm install working-directory: ./documentation - name: Build Docusaurus site - run: pnpm run build + run: npm run build working-directory: ./documentation - name: Upload artifact for deployment diff --git a/documentation/docs/examples/congratulations.md b/documentation/docs/examples/congratulations.md index 04771a00..83892193 100644 --- a/documentation/docs/examples/congratulations.md +++ b/documentation/docs/examples/congratulations.md @@ -6,9 +6,7 @@ sidebar_position: 6 You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. +Docusaurus has **much more to offer**! Test. Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)