separating examples in a repository of its own at https://github.com/ESA-EarthCODE/examples

Author: Schpidi

.github/workflows/deploy.yml

@@ -23,10 +23,6 @@ concurrency:
   group: pages
   cancel-in-progress: false
 
-env:
-  # BASE_URL for MyST build
-  BASE_URL: /${{ github.event.repository.name }}/examples
-
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -50,22 +46,10 @@ jobs:
         run: npm ci # or pnpm install / yarn install / bun install
       - name: Build with VitePress
         run: npm run build # or pnpm docs:build / yarn docs:build / bun run docs:build
-      - name: Move VitePress build under path /documentation
-        run: mkdir deploy && mv .vitepress/dist/ deploy/documentation/
-      - name: Install MyST
-        run: npm install -g mystmd
-      - name: Build MyST HTML Assets
-        run: cd examples/ && myst build --html
-      - name: Move MyST build under path /examples
-        run: mv examples/_build/html/ deploy/examples/
-      - name: Add index.html for initial links
-        run: echo 'EarthCODE <a href="documentation/">Documentation</a> and <a href="examples/">examples</a>' > deploy/index.html
-      - name: No Jekyll build
-        run: touch deploy/.nojekyll
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          folder: deploy/
+          folder: .vitepress/dist
           branch: gh-pages
           clean-exclude: pr-preview
           force: false

.github/workflows/preview.yml

@@ -18,10 +18,6 @@ on:
 # do not allow running multiple of pipelines for this PR in parallel
 concurrency: preview-${{ github.ref }}
 
-env:
-  # BASE_URL for MyST build
-  BASE_URL: /${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.number }}/examples
-
 jobs:
   deploy-preview:
     runs-on: ubuntu-latest
@@ -50,26 +46,11 @@ jobs:
         env:
           PR_NUMBER: ${{ github.event.number }}
         if: github.event.action != 'closed'
-        run: sed -e "s|/documentation/documentation/|/documentation/pr-preview/pr-${PR_NUMBER}/documentation/|g" -i .vitepress/config.mjs
+        run: sed -e "s|/documentation/|/documentation/pr-preview/pr-${PR_NUMBER}/documentation/|g" -i .vitepress/config.mjs
       - name: Build with VitePress
         if: github.event.action != 'closed'
         run: npm run build # or pnpm docs:build / yarn docs:build / bun run docs:build
-      - name: Move VitePress build under path /documentation
-        if: github.event.action != 'closed'
-        run: mkdir deploy && mv .vitepress/dist/ deploy/documentation/
-      - name: Install MyST
-        if: github.event.action != 'closed'
-        run: npm install -g mystmd
-      - name: Build MyST HTML Assets
-        if: github.event.action != 'closed'
-        run: cd examples/ && myst build --html
-      - name: Move MyST build under path /examples
-        if: github.event.action != 'closed'
-        run: mv examples/_build/html/ deploy/examples/
-      - name: Add index.html for initial links
-        if: github.event.action != 'closed'
-        run: echo 'EarthCODE <a href="documentation/">Documentation</a> and <a href="examples/">examples</a>' > deploy/index.html
       - name: Deploy preview
         uses: rossjrw/pr-preview-action@v1
         with:
-          source-dir: deploy/
+          source-dir: .vitepress/dist/

.gitignore

@@ -1,7 +1,6 @@
 node_modules
 .vitepress/dist
 .vitepress/cache
-examples/_build
 .DS_Store
 pages/.DS_Store
 pages/Community and Collaboration/.DS_Store

.vitepress/config.mjs

@@ -10,11 +10,7 @@ const sideBar = withSidebar(
     titleTemplate: " EarthCODE",
     collapsed: true,
     description: "Documentation for the EarthCODE website",
-    base: "/documentation/documentation/",
-    ignoreDeadLinks: [
-        // ignore all links include "/examples/""
-        /\/examples\//,
-    ],
+    base: "/documentation/",
     head: [
       ["link", { rel: "icon", href: "/img/EarthCODE_Favicon_32x32px.png" }],
       // Open Graph / Facebook
@@ -110,7 +106,7 @@ const sideBar = withSidebar(
 )
 
 const trainingSection = sideBar.themeConfig.sidebar.find(section => section.text === 'Training and Resources')
-trainingSection.items.push({ text: 'Examples', link: 'https://esa-earthcode.github.io/documentation/examples/' })
+trainingSection.items.push({ text: 'Examples', link: 'https://esa-earthcode.github.io/examples/' })
 
 sideBar.themeConfig.sidebar.forEach(group => {
   group.collapsed = true;

README.md

@@ -1,25 +1,10 @@
 # EarthCODE Documentation
 
-The EarthCODE Documentation has two parts, the documentation using VitePress and examples using MyST.
+The EarthCODE Documentation using VitePress.
 
 ```
 npm install
-```
-
-## Documentation
-
-Using VitePress
-
-```
 npm run dev
 npm run build
 npm run preview
 ```
-
-## Examples
-
-Using MyST
-
-```
-myst start
-```