Hosting Documentation in Netlify or Vercel

[yezz123]

Hey @adriangb I have i little enhancement on the way how you could improve the CI/CD of Xpresso, the same thing I try it before in AuthX, the same thing we use MKdocs in Documentation that's why you could build it and generate HTML main file and some assets files .js & .css, that's why you could host it in Netlify using jsmrcaga/[email protected] here is the CI File i use it in authx to host it in Netlify:

name: Build Docs
on:
  push:
    branches:
      - main

jobs:
  build-docs:
    runs-on: ubuntu-18.04
    steps:
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}
        run: echo "$GITHUB_CONTEXT"
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.9"
      - uses: actions/cache@v2
        id: cache
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-docs
      - name: Install Flit
        if: steps.cache.outputs.cache-hit != 'true'
        run: python3.9 -m pip install flit
      - name: Install docs extras
        if: steps.cache.outputs.cache-hit != 'true'
        run: python3.9 -m flit install --deps production --extras docs
      - name: Build docs
        run: mkdocs build -d build

      - name: Deploy docs
        uses: jsmrcaga/[email protected]
        with:
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
          NETLIFY_DEPLOY_TO_PROD: true
          NETLIFY_DEPLOY_MESSAGE: "Prod deploy v${{ github.ref }}"

[adriangb]

I've tried Netlify before for docs. I really don't see any advantage over GitHub Pages for something simple like this. Could you help me understand what the advantage of Netflify is for this use case?

I also worry that those systems offer less freedom vs. GitHub Actions + Pages, for example getting versioned docs using Mike to work sounds more challenging.