Update quick start example to better show how to utilize docker #148
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "🦕 Docusaurus Documentation Website (PR Preview)" | |
| concurrency: preview-${{ github.ref }} | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - closed | |
| paths: | |
| - "website/**" | |
| - ".github/workflows/pull_request_docs_preview.yml" | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| defaults: | |
| run: | |
| working-directory: website | |
| jobs: | |
| deploy-preview: | |
| if: github.event.pull_request.head.ref != 'release-prep' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: 22 | |
| cache: npm | |
| cache-dependency-path: website/package-lock.json | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Build website | |
| run: npm run build | |
| env: | |
| PR_NUMBER: ${{ github.event.pull_request.number }} | |
| - name: Deploy preview | |
| uses: rossjrw/pr-preview-action@v1 | |
| with: | |
| source-dir: ./website/build/ | |
| # - name: Comment PR | |
| # uses: actions/github-script@v7 | |
| # with: | |
| # script: | | |
| # const url = `https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.pull_request.number }}/`; | |
| # const comment = `### 📖 Documentation Preview | |
| # The documentation preview for this PR is available at: | |
| # ${url} | |
| # This preview will be updated automatically when the PR is updated.`; | |
| # github.rest.issues.createComment({ | |
| # issue_number: context.issue.number, | |
| # owner: context.repo.owner, | |
| # repo: context.repo.repo, | |
| # body: comment | |
| # }); |