[doc] Migrate Venice docs from Jekyll to MkDocs Material

.github/workflows/deploy-docs.yml

@@ -0,0 +1,50 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git remote set-head origin --auto
+          git remote add upstream https://github.com/linkedin/venice
+          git fetch upstream
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r docs/doc-requirements.txt
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Validate Gradle wrapper
+        uses: gradle/actions/wrapper-validation@v3
+
+      - name: Generate Javadoc
+        run: ./gradlew aggregateJavadoc
+
+      - name: Copy Javadoc
+        run: |
+          mkdir -p docs/javadoc
+          cp -r build/javadoc/* docs/javadoc/
+
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -18,6 +18,7 @@
 .shelf/
 out/
 build/
+site/
 internal/venice-test-common/tmp/
 internal/venice-test-common/dump.complete.hprof
 internal/venice-test-common/src/jmh/generated

build.gradle

@@ -632,6 +632,12 @@ spotless {
     target '**/src/**/*.java'
     targetExclude '**/generated/**'
   }
+  format 'markdown', {
+    target '**/*.md'
+    targetExclude '**/build/**', '**/target/**', '**/.gradle/**'
+    prettier(['prettier': '2.8.8', 'prettier-plugin-java': '2.2.0'])
+        .config(['proseWrap': 'always', 'printWidth': 120])
+  }
 }
 
 task setupWorkspace {

docs/assets/style/extra.css

@@ -0,0 +1,49 @@
+/* Venice Documentation Custom Styles */
+/* Brand colors: Black and White */
+
+:root {
+  --venice-black: #000000;
+  --venice-white: #ffffff;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color: var(--venice-black);
+  --md-accent-fg-color: var(--venice-white);
+}
+
+[data-md-color-scheme="default"] {
+  --md-primary-fg-color: var(--venice-black);
+  --md-accent-fg-color: var(--venice-black);
+}
+
+.md-typeset table:not([class]) {
+  border-radius: 0.5rem;
+  overflow: hidden;
+}
+
+.md-button {
+  border-radius: 0.5rem;
+}
+
+.md-typeset code {
+  border-radius: 0.25rem;
+}
+
+.md-typeset pre > code {
+  border-radius: 0.5rem;
+}
+
+/* Hide permalink icon by default, show only on heading hover */
+.md-typeset .headerlink {
+  opacity: 0;
+  transition: opacity 0.2s;
+}
+
+.md-typeset h1:hover .headerlink,
+.md-typeset h2:hover .headerlink,
+.md-typeset h3:hover .headerlink,
+.md-typeset h4:hover .headerlink,
+.md-typeset h5:hover .headerlink,
+.md-typeset h6:hover .headerlink {
+  opacity: 1;
+}