Site rearrangement

* Simplifies navigation (replace 9 sections with 5) * Moves pages "around" * Moves Nessie release dependent files to separate directory * Adds Nessie version dependent docs - released versions end in the `site-docs` branch in the `projectnessie/nessie` GitHub repo * Adds helper scripts + Makefile to develop locally (`make build` + `make serve`) * Adds helper scripts for the Nessie `release-create` workflow * Use the `blog` plugin for the blog * Use the `monorepo` plugin for version dependent docs * Use the `privacy` plugin * Use the `redirects` plugin to let existing links work (being redirected) Fixes #3464 Fixes #2459
projectnessie · Apr 12, 2024 · 73aa960 · 73aa960
1 parent 44cc4eb
commit 73aa960
Show file tree

Hide file tree

Showing 86 changed files with 1,292 additions and 502 deletions.
diff --git a/.github/actions/bump-versions/action.yml b/.github/actions/bump-versions/action.yml
diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml
@@ -79,11 +79,6 @@ jobs:
         echo "BUMPED_VERSION=$(cat version.txt)" >> ${GITHUB_ENV}
         echo "BUMPED_VERSION_NO_SNAPSHOT=${BUMPED_VERSION%-SNAPSHOT}" >> ${GITHUB_ENV}
 
-    - name: Bump versions for Python, site/, helm and UI
-      uses: ./.github/actions/bump-versions
-      with:
-        new-version: ${{ env.BUMPED_VERSION_NO_SNAPSHOT }}
-
     - name: Configure bump-version-bot-user in git config
       run: |
         git config --global user.email "nessie-bump-version-workflow-noreply@projectnessie.org"

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -901,19 +901,13 @@ jobs:
       - name: Setup Python
         uses: ./.github/actions/dev-tool-python
         with:
-          python-version: '3.8'
-      - name: Upgrade pip
-        run: |
-          # install pip=>20.1 to use "pip cache dir"
-          python3 -m pip install --upgrade pip
-      - name: Install dependencies
-        run: python3 -m pip install -r ./site/requirements.txt
+          python-version: '3.11'
+      - name: Generate Static Site
+        run: make build
+        working-directory: ./site
       - name: Check code block indentation
         run: python3 check_code_indent.py
         working-directory: ./site
-      - name: Generate Static Site
-        run: mkdocs build
-        working-directory: ./site
       - name: Deploy Static Site to GitHub
         if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository == 'projectnessie/nessie'
         uses: peaceiris/actions-gh-pages@v4

diff --git a/.github/workflows/release-create.yml b/.github/workflows/release-create.yml
@@ -104,7 +104,7 @@ jobs:
         LAST_VERSION="${LAST_TAG#nessie-}"
         LAST_VERSION_PATTERN="$(echo ${LAST_VERSION} | sed 's/\([^.]*\)[.]\([^.]*\)[.].*/\1\\.\2/')\\."
 
-        for fn in SECURITY.md README.md site/docs/try/server-upgrade.md ; do
+        for fn in SECURITY.md README.md site/docs/server-upgrade.md ; do
           sed -i "s/${LAST_VERSION_PATTERN}[^ ]*/${RELEASE_VERSION}/" ${fn}
         done
 
@@ -115,34 +115,38 @@ jobs:
         FAILS=""
         # version pattern without patch version
         VERSION_PATTERN="$(echo ${RELEASE_VERSION} | sed 's/\([^.]*\)[.]\([^.]*\)[.].*/\1\\.\2/')\\."
-        grep -q " ${VERSION_PATTERN}" < site/docs/try/server-upgrade.md || FAILS="${FAILS} site/docs/try/server-upgrade.md"
+        grep -q " ${VERSION_PATTERN}" < site/docs/server-upgrade.md || FAILS="${FAILS} site/docs/server-upgrade.md"
         grep -q "^| ${VERSION_PATTERN}" < README.md || FAILS="${FAILS} README.md"
         grep -q "^| ${VERSION_PATTERN}.* .*check_mark.*$" < SECURITY.md || FAILS="${FAILS} SECURITY.md"
         if [[ -n ${FAILS} ]] ; then
           echo ${FAILS} "do not match the version pattern ${VERSION_PATTERN}."
           exit 1
         fi
 
-    - name: Bump versions for site/ and helm
-      uses: ./.github/actions/bump-versions
-      with:
-        new-version: ${{ env.RELEASE_VERSION }}
-        bump-helm-version: 'true'
-        bump-site-version: 'true'
-
     - name: Patch changelog
       uses: gradle/actions/setup-gradle@v3
       with:
         cache-disabled: true
         arguments: :patchChangelog
 
-    # Updates the site/docs/try/releases.md file, takes the first four lines (the big heading),
+    - name: Update site
+      shell: bash
+      working-directory: site
+      run: |
+        bin/release.sh ${RELEASE_VERSION}
+
+    - name: Bump version in helm/nessie
+      shell: bash
+      run: |
+        sed -i "s/^version: [0-9.]*$/version: ${RELEASE_VERSION}/" helm/nessie/Chart.yaml
+
+    # Updates the site/docs/releases.md file, takes the first four lines (the big heading),
     # adds a heading with the version and a note referencing the release notes on GitHub,
     # followed by the Git change log, finalized with the remainder of the
-    # previous site/docs/try/releases.md file.
+    # previous site/docs/releases.md file.
     - name: Update releases.md file
       run: |
-        head -4 site/docs/try/releases.md > /tmp/releases.md
+        head -4 site/docs/releases.md > /tmp/releases.md
         cat <<!  >> /tmp/releases.md
         ## ${RELEASE_VERSION} Release ($(date '+%B %d, %Y'))
         
@@ -157,10 +161,10 @@ jobs:
         git log --perl-regexp --author '^(?!.*renovate|.*nessie-release-workflow).*$'\
           --format='format:* %s' ${LAST_TAG}..HEAD . |\
           grep -v '^\* \[release\] .*$' >> /tmp/releases.md || true
-        
-        tail +4 site/docs/try/releases.md >> /tmp/releases.md
-        
-        cp /tmp/releases.md site/docs/try/releases.md
+
+        tail +4 site/docs/releases.md >> /tmp/releases.md
+
+        cp /tmp/releases.md site/docs/releases.md
         rm /tmp/releases.md
 
     - name: Update helm/README.md
@@ -218,11 +222,6 @@ jobs:
         | Git HEAD                   | \`$(git rev-parse HEAD)\` |
         !
 
-    - name: Bump versions for site/ and helm
-      uses: ./.github/actions/bump-versions
-      with:
-        new-version: ${{ env.NEXT_VERSION_NO_SNAPSHOT }}
-
       # Record the next development iteration in Git
     - name: Record next development version in Git
       run: git commit -a -m "[release] next development iteration ${NEXT_VERSION}"
@@ -238,6 +237,9 @@ jobs:
         # Move the default auth settings in ~/.gitconfig out of the way, so the git-push can use the token
         git config --rename-section http.https://github.com/ http.https://save.github.com/
 
+        # Push changes to docs to site-docs branch
+        (cd site/build/site-docs ; git push --no-verify "${UPSTREAM}" HEAD:site-docs)
+
         git push --no-verify "${UPSTREAM}" HEAD:${GITHUB_REF} ${GIT_TAG}
 
         # Move the default auth settings in ~/.gitconfig back

diff --git a/.gitignore b/.gitignore
@@ -66,8 +66,5 @@ venv/
 __pycache__/
 .python-version
 
-# Site
-site/site
-
 #jEnv, see https://github.com/jenv/jenv
 .java-version
diff --git a/gc/README.md b/gc/README.md
@@ -1,3 +1,3 @@
 # Nessie GC
 
-See [here](../site/docs/features/gc.md).
+See [here](../site/in-dev/gc.md).