[Docs] Reorganize the documents to adapt website building

.github/workflows/docs.yml

@@ -24,65 +24,59 @@ on:
   pull_request:
     branches:
       - main
+    paths:
+      - 'docs/**'
+      - 'cpp/**'
+      - 'java/**'
+      - 'spark/**'
+      - 'pyspark/**'
+      - '.github/workflows/docs.yml'
 
 concurrency:
   group: ${{ github.repository }}-${{ github.event.number || github.head_ref || github.sha }}-${{ github.workflow }}
   cancel-in-progress: true
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  build-website:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
     steps:
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-
-      - name: Checkout Code
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.event.pull_request.head.ref }}
           submodules: true
           fetch-depth: 0
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
 
-      - name: Install Python
-        uses: actions/setup-python@v4
+      - uses: actions/setup-node@v4
         with:
-          python-version: 3.9
+          node-version: '18'
 
-      - name: Install dependencies
-        run: |
-          sudo apt-get update -y
-          sudo apt-get install -y ca-certificates doxygen
-          curl -sSL https://install.python-poetry.org | python3 -
-          # install poetry
-          yes | sudo python3 -m pip install poetry --quiet
-          poetry env use python3
-          # install dependencies with poetry
-          poetry install --with=docs,spark
-        working-directory: ./pyspark
+      - name: Checkout website
+        uses: actions/checkout@v4
+        with:
+          repository: apache/incubator-graphar-website
+          path: website
+          ref: main
 
-      - name: Generate Doc
+      - name: Sync docs to website
+        working-directory: ${{ github.workspace }}
         run: |
-          export JAVA_HOME=${JAVA_HOME_11_X64}
-          make html
-        working-directory: ./docs
+          # Note: DO NOT omit the trailing slash in the source directory
+          rsync -av docs/ website/docs
+
+      - name: Install Dependencies
+        working-directory: website
+        run: pnpm install --frozen-lockfile
 
-      - name: Commit Doc
-        # TODO: open this when apache infrastructure is ready
-        # if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' && github.repository == 'apache/incubator-graphar' }}
-        if: false
-        run: |
-          git config user.email github-actions@github.com
-          git config user.name github-actions
-          git branch -D gh-pages || true
-          git checkout --orphan gh-pages
-          shopt -s extglob
-          rm -rf !(docs)
-          rm -rf .github .clang-format .gitattributes .gitmodules .gitignore
-          mv docs/_build/html/* ./
-          mv docs/_build/html/.nojekyll ./
-          rm -rf docs
-          git add -A
-          git commit -m "Generate latest docs on CI, from commit ${{ github.sha }}."
-          git push -f origin gh-pages
+      - name: Build
+        working-directory: website
+        run: pnpm build
+
+# TODO: enable markdownlint & typos

.github/workflows/license.yml

@@ -30,7 +30,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build:
+  check:
     runs-on: ubuntu-latest
     steps:
 

docs/README.md

@@ -0,0 +1,10 @@
+# Apache GraphAr Documentation
+
+This directory contains the source files for building the main
+project documentation for Apache GraphAr (incubating). This include
+the GraphAr Format specification and libraries.
+
+Instructions for building the documentation site are found in the
+[website README][1].
+
+[1]: https://github.com/apache/incubator-graphar-website/blob/main/README.md