Merge branch 'ExpressionEngine:7.dev' into patch-2

Author: nep

.github/workflows/build.yml

@@ -0,0 +1,45 @@
+name: Build Docs
+
+on:
+  push:
+    branches:
+      - 7.x
+      - 7.dev
+
+jobs:
+  build:
+    name: Build Documentation HTML
+    runs-on: ubuntu-latest
+    outputs:
+      DOCSEARCH_INDEX: ${{ steps.setup_vars.outputs.DOCSEARCH_INDEX }}
+      DOCS_URL: ${{ steps.setup_vars.outputs.DOCS_URL }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Variables
+        id: setup_vars
+        run: |
+          if [[ "${{github.base_ref}}" == "7.x" || "${{github.ref}}" == "refs/heads/7.x" ]]; then
+            echo "DOCSEARCH_INDEX=expressionengine7" >> "$GITHUB_OUTPUT"
+          else
+            echo "DOCSEARCH_INDEX=expressionengine7_staging" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Update Docsearch Index
+        uses: richardrigutins/replace-in-files@v2
+        with:
+          search-text: "docsearch_index: 'expressionengine'"
+          replacement-text: "docsearch_index: '${{steps.setup_vars.outputs.DOCSEARCH_INDEX}}'"
+          files: ./config.yml
+
+      - name: Install NPM and build
+        run: |
+          npm install
+          npm run build
+
+      - name: Archive Build files
+        uses: actions/upload-artifact@v4
+        with:
+          name: EEDocs7.latest
+          path: build

.github/workflows/publish-prod.yml

@@ -0,0 +1,48 @@
+name: Update Search
+
+on:
+  workflow_dispatch:
+
+jobs:
+  search:
+    name: Build Search Index
+    runs-on: ubuntu-latest
+    steps:
+        - name: Checkout code
+          uses: actions/checkout@v4
+
+        - name: Setup Variables
+          run: |
+            if [[ "${{github.base_ref}}" == "7.x" || "${{github.ref}}" == "refs/heads/7.x" ]]; then
+              echo "DOCSEARCH_INDEX=expressionengine7" >> "$GITHUB_ENV"
+              echo "DOCS_URL=https://docs.expressionengine.com/latest" >> "$GITHUB_ENV"
+            else
+              echo "DOCSEARCH_INDEX=expressionengine7_staging" >> "$GITHUB_ENV"
+              echo "::add-mask::${{secrets.STAGING_DOCS_DOMAIN}}"
+              echo "DOCS_URL=${{secrets.STAGING_DOCS_URL}}" >> "$GITHUB_ENV"
+            fi
+
+        - name: Configure Docsearch Index
+          uses: richardrigutins/replace-in-files@v2
+          with:
+            search-text: "\"index_uid\": \"expressionengine\""
+            replacement-text: "\"index_uid\": \"${{ env.DOCSEARCH_INDEX }}\""
+            files: ./search.config.json
+
+        - name: Configure Docs Url
+          uses: richardrigutins/replace-in-files@v2
+          with:
+            search-text: "https://docs.expressionengine.com/latest"
+            replacement-text: ${{ env.DOCS_URL }}
+            files: ./search.config.json
+
+        - name: Scrape Docs
+          env:
+            HOST_URL: ${{ secrets.MEILISEARCH_HOST_URL }}
+            API_KEY: ${{ secrets.MEILISEARCH_API_KEY }}
+          run: |
+            docker run -t --rm \
+            -e MEILISEARCH_HOST_URL=$HOST_URL \
+            -e MEILISEARCH_API_KEY=$API_KEY \
+            -v ./search.config.json:/docs-scraper/search.config.json \
+            getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json

.github/workflows/publish-staging.yml

@@ -32,7 +32,30 @@ To build the theme assets, run `npm run buildAssets`. You can also dynamically r
 
 ### Viewing local changes
 
-Manually load `/build/index.html` in your browser to view your local build. For example, `file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html`. You can use the side navigation to navigate to different local files, but the search functionality always takes you to the live version at docs.expressionengine.com.
+There are 2 options for viewing your local changes.
+
+1. Run `npx http-server -o` which should make the site available at [http://127.0.0.1:8080/build/](http://127.0.0.1:8080/build/).
+2. Manually view any HTML file in `/build/` in your browser. For example, `file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html` to view the home page.
+
+You can use the side navigation to navigate to different local files, but the search functionality takes you to the live version at [https://docs.expressionengine.com](https://docs.expressionengine.com) unless you follow the steps at [Using DocSearch Locally](#using-docsearch-locally).
+
+## Using DocSearch Locally
+
+First you will need to choose a docsearch index name to use for your local testing and set that in `config.yml`
+
+Then you will need to build the docs and serve a local copy.  For simplicity's sake we recommend using the node http-server like this `npx http-server -o`
+
+Next you will need to update all the urls in `search.config.json` to point at your local copy of the documentation.  Do a find/replace on `https://docs.expressionengine.com/latest` => `http://localhost:8080`.  You will also need to update the `allowed_domains` array to include this new url. (If you are on a mac you may need to use `http://host.docker.internal:8080` instead so that the scraper container can connect to the docs on your local http-server.)
+
+Finally you can scrape your local docs with the following docker command
+
+```
+docker run -t --rm --network=host \
+    -e MEILISEARCH_HOST_URL=https://docsearch.expressionengine.com \
+    -e MEILISEARCH_API_KEY={{ SECRET_KEY }} \
+    -v ./search.config.json:/docs-scraper/search.config.json \
+    getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json
+```
 
 ## Contributing
 

.github/workflows/search.yml

@@ -8,3 +8,5 @@ themeDir: theme
 customVariables:
   current_version: '7'
   current_year: 2024
+  docsearch_index: 'expressionengine'
+  docsearch_public_key: '7d283b55c1d7c0e5f340c71b5dfc751d8dc625708f29e582134f7643bc95dbd7'

README.md

@@ -4,7 +4,7 @@
 {exp:rss:feed channel="{master_channel_name}"}
 
 <?xml version="1.0" encoding="{encoding}"?>
-<feed xmlns="https://www.w3.org/2005/Atom" xml:lang="{channel_language}">
+<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="{channel_language}">
 
     <title type="text"><![CDATA[{channel_name}]]></title>
     <subtitle type="text"><![CDATA[{channel_name} - {channel_description}]]></subtitle>
@@ -39,4 +39,4 @@
 
 </feed>
 
-{/exp:rss:feed}
+{/exp:rss:feed}