Publish the docs on GitHub Pages

.github/licenses.tmpl

@@ -7,7 +7,7 @@ sidebar_label: OSS Licenses
 
 The following open source dependencies are used to build the [DevPod][] CLI.
 
-[DevPod]: https://devpod.sh
+[DevPod]: https://github.com/curityio/devpod
 
 ## Go Packages
 

.github/workflows/docs.yaml

@@ -0,0 +1,62 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/**
+      - .github/workflows/docs.yaml
+  pull_request:
+    branches:
+      - main
+    paths:
+      - docs/**
+      - .github/workflows/docs.yaml
+  workflow_dispatch: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: yarn
+          cache-dependency-path: docs/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build
+        run: yarn build
+
+      - name: Upload site
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build
+
+  deploy:
+    if: github.event_name != 'pull_request'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

AGENTS.md

@@ -14,7 +14,7 @@ VMs). [CHANGELOG.md](CHANGELOG.md) lists what the fork changed and [TODO.md](TOD
 | `pkg/` | Core Go code: `devcontainer/` (parsing, building and running dev containers), `driver/` (docker, kubernetes, custom), `workspace/`, `provider/`, `client/`, `agent/` (agent injection and the gRPC tunnel between CLI and agent), `ide/`, `ssh/`, `credentials/`, `config/`. |
 | `providers/` | The built-in `docker` and `kubernetes` provider definitions, embedded into the binary. Other providers live in separate repos. |
 | `desktop/` | The desktop app: Tauri 2 (Rust, `desktop/src-tauri`) with a React/TypeScript UI (`desktop/src`). It runs the `devpod` CLI as a sidecar. |
-| `docs/` | Docusaurus documentation site. |
+| `docs/` | Docusaurus documentation site, deployed to [curityio.github.io/devpod](https://curityio.github.io/devpod/) by `.github/workflows/docs.yaml` on pushes to `main`. |
 | `e2e/` | Ginkgo end-to-end tests that run the real CLI against Docker, Podman and a kind cluster. |
 | `hack/` | Build and test scripts. |
 | `examples/` | Sample devcontainer projects, also used by the e2e tests. |

CHANGELOG.md

@@ -32,6 +32,10 @@ Add new entries to the top of the "Unreleased" section.
 
 ### Changed
 
+- The documentation is published on this repository's GitHub Pages site,
+  [curityio.github.io/devpod](https://curityio.github.io/devpod/), instead of Loft's devpod.sh
+  ([#9](https://github.com/curityio/devpod/pull/9)). Links in the README, guides and desktop app point
+  there. The Netlify config and Loft's Algolia search are removed, so the docs have no search for now.
 - The desktop app checks for updates in `curityio/devpod` GitHub releases instead of Loft's update
   server ([#7](https://github.com/curityio/devpod/pull/7)).
 - Links point to `curityio/devpod` instead of `loft-sh/devpod`, the README has a hard-fork note and

CONTRIBUTING.md

@@ -48,7 +48,7 @@ The application should be in `desktop/src-tauri/target/release`
 
 ## Provider
 
-Head over to [the docs](https://devpod.sh/docs/developing-providers/quickstart)
+Head over to [the docs](https://curityio.github.io/devpod/developing-providers/quickstart)
 for an introduction into developing your own providers
 
 ### Publish your provider

README.md

@@ -19,7 +19,7 @@
   </a>
 </p>
 
-### **[Quickstart](https://www.devpod.sh/docs/getting-started/install)** • **[Documentation](https://www.devpod.sh/docs/what-is-devpod)** • **[Issues](https://github.com/curityio/devpod/issues)** • **[Curity](https://curity.io/)**
+### **[Quickstart](https://curityio.github.io/devpod/getting-started/install)** • **[Documentation](https://curityio.github.io/devpod/what-is-devpod)** • **[Issues](https://github.com/curityio/devpod/issues)** • **[Curity](https://curity.io/)**
 
 DevPod is a client-only tool to create reproducible developer environments based on a [devcontainer.json](https://containers.dev/) on any backend. Each developer environment runs in a container and is specified through a [devcontainer.json](https://containers.dev/). Through DevPod providers, these environments can be created on any backend, such as the local computer, a Kubernetes cluster, any reachable remote machine, or in a VM in the cloud.
 
@@ -33,7 +33,7 @@ Download DevPod Desktop:
 - [Windows](https://github.com/curityio/devpod/releases/latest/download/DevPod_windows_x64_en-US.msi)
 - [Linux AppImage](https://github.com/curityio/devpod/releases/latest/download/DevPod_linux_amd64.AppImage)
 
-Take a look at the [DevPod Docs](https://devpod.sh/docs/getting-started/install) for more information.
+Take a look at the [DevPod Docs](https://curityio.github.io/devpod/getting-started/install) for more information.
 
 ## Why DevPod?
 

SECURITY.md

@@ -1,10 +1,10 @@
 # Security Policy
 We will disclose fixes for vulnerabilities in the release notes and urge you to upgrade once a new release is published. 
-For upgrading guidelines, see [our official Upgrading Guideline](https://devpod.sh/docs/getting-started/update).
+For upgrading guidelines, see [our official Upgrading Guideline](https://curityio.github.io/devpod/getting-started/update).
 
 **To receive update warnings in the CLI (as part of the terminal output whenever you run a command), you must use an official release binary as published on the [GitHub releases page](https://github.com/curityio/devpod/releases) of this project.**
 
-See the [install instructions for DevPod](https://devpod.sh/docs/getting-started/install) for the recommended methods of downloading an official release binary for your platform. Community maintained release binaries may **not** contain the version number and will therefore not be able to perform a version check.
+See the [install instructions for DevPod](https://curityio.github.io/devpod/getting-started/install) for the recommended methods of downloading an official release binary for your platform. Community maintained release binaries may **not** contain the version number and will therefore not be able to perform a version check.
 
 
 ## Reporting a Vulnerability

TODO.md

@@ -44,3 +44,10 @@ used in `pkg/telemetry`) unless the context option `TELEMETRY=false` or `DEVPOD_
 
 - [ ] Remove telemetry (and the `analytics-client` dependency), or point it at a Curity endpoint
 - [ ] Update the `TELEMETRY` context option and the docs that mention telemetry accordingly
+
+## Host the IDE and provider icons ourselves
+
+The IDE icons (`pkg/ide/ideparse/parse.go`) and the built-in provider icons (`providers/*/provider.yaml`) are loaded from
+Loft's website, `https://devpod.sh/assets/...`:
+
+- [ ] Copy the icons into this repository (e.g. the docs site's static files) and point the URLs at our copies

desktop/flatpak/DevPod.metainfo.xml

@@ -9,7 +9,7 @@
   <metadata_license>FSFAP</metadata_license>
   <project_license>MPL-2.0</project_license>
 
-  <url type="homepage">https://devpod.sh</url>
+  <url type="homepage">https://github.com/curityio/devpod</url>
   <url type="vcs-browser">https://github.com/curityio/devpod</url>
   <url type="bugtracker">https://github.com/curityio/devpod/issues</url>
 
@@ -28,15 +28,15 @@
   <launchable type="desktop-id">sh.loft.devpod.desktop</launchable>
   <screenshots>
     <screenshot type="default">
-      <image>https://devpod.sh/docs/media/devpod-architecture-2.png</image>
+      <image>https://curityio.github.io/devpod/media/devpod-architecture-2.png</image>
       <caption>Devpod Architecture</caption>
     </screenshot>
     <screenshot>
-      <image>https://devpod.sh/docs/media/add-provider-2.png</image>
+      <image>https://curityio.github.io/devpod/media/add-provider-2.png</image>
       <caption>Adding a Provider</caption>
     </screenshot>
     <screenshot>
-      <image>https://devpod.sh/docs/media/create-workspace-vscode-browser.png</image>
+      <image>https://curityio.github.io/devpod/media/create-workspace-vscode-browser.png</image>
       <caption>Using vscode in the browser</caption>
     </screenshot>
   </screenshots>

desktop/src/components/Layout/StatusBar.tsx

@@ -112,7 +112,7 @@ function OSSDocs() {
         rounded="full"
         icon={<Icon as={HiDocumentMagnifyingGlass} color={iconColor} />}
         aria-label="How to DevPod - Docs"
-        onClick={() => client.open("https://devpod.sh/docs")}
+        onClick={() => client.open("https://curityio.github.io/devpod")}
       />
     </Tooltip>
   )

desktop/src/useWelcomeModal.tsx

@@ -85,7 +85,7 @@ export function useWelcomeModal() {
                     cloud. It's also possible to extend DevPod and write your own custom
                     providers. <br />
                     For more information, head over to our{" "}
-                    <Link onClick={() => client.open("https://devpod.sh/docs")}>
+                    <Link onClick={() => client.open("https://curityio.github.io/devpod")}>
                       documentation.
                     </Link>
                   </Text>
@@ -104,7 +104,8 @@ export function useWelcomeModal() {
                   <Text>
                     DevPod ships with a powerful CLI that allows you to create, manage and connect
                     to your workspaces and providers. You can either{" "}
-                    <Link onClick={() => client.open("https://github.com/curityio/devpod/releases")}>
+                    <Link
+                      onClick={() => client.open("https://github.com/curityio/devpod/releases")}>
                       download the standalone binary
                     </Link>{" "}
                     or directly add it to your <Code>$PATH</Code>.

desktop/src/views/Settings/useContextOptions.tsx

@@ -86,7 +86,8 @@ export function useTelemetryOption() {
         Telemetry plays an important role in improving DevPod for everyone.{" "}
         <strong>We never collect any actual values, only anonymized metadata!</strong> For an
         in-depth explanation, please refer to the{" "}
-        <Link onClick={() => client.open("https://devpod.sh/docs/other-topics/telemetry")}>
+        <Link
+          onClick={() => client.open("https://curityio.github.io/devpod/other-topics/telemetry")}>
           documentation
         </Link>
       </>

docs/docusaurus.config.js

@@ -1,12 +1,12 @@
-__webpack_public_path__ = "/docs/";
+__webpack_public_path__ = "/devpod/";
 
 module.exports = {
   title: "DevPod docs | DevContainers everywhere",
   tagline: "DevContainers everywhere",
-  url: "https://devpod.sh",
+  url: "https://curityio.github.io",
   baseUrl: __webpack_public_path__,
   favicon: "/media/devpod-favicon.svg",
-  organizationName: "loft-sh", // Usually your GitHub org/user name.
+  organizationName: "curityio", // Usually your GitHub org/user name.
   projectName: "devpod", // Usually your repo name.
   themeConfig: {
     colorMode: {
@@ -19,18 +19,10 @@ module.exports = {
         alt: "devpod",
         src: "/media/devpod-logo-horizontal.svg",
         srcDark: "/media/devpod-logo-horizontal-dark.svg",
-        href: "https://devpod.sh/",
-        target: "_self",
       },
       items: [
         {
-          href: "https://devpod.sh/",
-          label: "Website",
-          position: "left",
-          target: "_self",
-        },
-        {
-          to: "/docs/what-is-devpod",
+          to: "/what-is-devpod",
           label: "Docs",
           position: "left",
         },
@@ -42,14 +34,6 @@ module.exports = {
         },
       ],
     },
-    algolia: {
-      appId: "Y3XX0IC1ZW",
-      apiKey: "cfc452201042c6b5483694d4d0492aa8",
-      indexName: "devpod",
-      algoliaOptions: {},
-      placeholder: "Search...",
-      contextualSearch: false,
-    },
     footer: {
       style: "light",
       links: [],
@@ -79,7 +63,7 @@ module.exports = {
       async: true,
     },
     {
-      src: "/docs/js/custom.js",
+      src: __webpack_public_path__ + "js/custom.js",
       async: true,
     },
   ],

docs/pages/fragments/add-provider.mdx

@@ -2,14 +2,14 @@
 Add a provider via 'Providers' > '+ Add'. Select a provider and select 'Continue'.
 
 <figure>
-  <img src="/docs/media/add-provider-1.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/add-provider-1.png").default} alt="DevPod Flow" />
   <figcaption>Select Provider</figcaption>
 </figure>
 
 After selecting a provider, fill out the options (if necessary) and click on 'Add Provider'
 
 <figure>
-  <img src="/docs/media/add-provider-2.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/add-provider-2.png").default} alt="DevPod Flow" />
   <figcaption>Add Provider</figcaption>
 </figure>
 

docs/pages/fragments/virtualbox-ubuntu-22.04.mdx

@@ -51,7 +51,7 @@ Review the configuration summary and click 'Finish' to commence creating the VM.
 To start the Ubuntu installation, select the vm 'ubuntu-desktop-22.04' and 'Start'.
 
 <figure>
-  <img src="/docs/media/create-workspace-virtualbox-start-vm.png" alt="Virtualbox Start" />
+  <img src={require("@site/static/media/create-workspace-virtualbox-start-vm.png").default} alt="Virtualbox Start" />
   <figcaption>Virtualbox Start</figcaption>
 </figure>
 
@@ -66,7 +66,7 @@ Select 'Try/Install Ubuntu'
 Select Language and Install Ubuntu
 
 <figure>
-  <img src="/docs/media/create-workspace-virtualbox-install-ubuntu.png" alt="Install Ubuntu" />
+  <img src={require("@site/static/media/create-workspace-virtualbox-install-ubuntu.png").default} alt="Install Ubuntu" />
   <figcaption>Install Ubuntu</figcaption>
 </figure>
 

docs/pages/getting-started/quickstart-jetbrains.mdx

@@ -24,35 +24,35 @@ Make sure to install the following prerequisites:
 Navigate to 'Workspaces' > '+ Create'. Enter your project url or choose one of the quickstart examples. 
 
 <figure>
-<img src="/docs/media/create-workspace-repo.png" alt="DevPod Flow" />
+<img src={require("@site/static/media/create-workspace-repo.png").default} alt="DevPod Flow" />
   <figcaption>Create Workspace</figcaption>
 </figure>
 
 Make sure to select a JetBrains IDE under 'Default IDE'
 
 <figure>
-  <img src="/docs/media/create-workspace-jetbrains.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-jetbrains.png").default} alt="DevPod Flow" />
   <figcaption>Select IDE</figcaption>
 </figure>
 
 Then press 'Create Workspace'.
 
 <figure>
-  <img src="/docs/media/create-workspace-final-jetbrains.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-final-jetbrains.png").default} alt="DevPod Flow" />
   <figcaption>Create Workspace</figcaption>
 </figure>
 
 A new window appears showing DevPod starting the workspace. After the workspace was created, JetBrains Gateway should automatically open with a prefilled form for the workspace.
 
 <figure>
-  <img src="/docs/media/create-workspace-jetbrains-2.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-jetbrains-2.png").default} alt="DevPod Flow" />
   <figcaption>JetBrains Gateway opens automatically</figcaption>
 </figure>
 
 Press 'Check Connection and Continue' without changing any configuration. This should start the IDE in the workspace. After the IDE has been initialized, your JetBrains IDE should open up inside the workspace.
 
 <figure>
-  <img src="/docs/media/create-workspace-jetbrains-3.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-jetbrains-3.png").default} alt="DevPod Flow" />
   <figcaption>IDE opens within the workspace</figcaption>
 </figure>
 

docs/pages/getting-started/quickstart-ssh.mdx

@@ -18,21 +18,21 @@ Make sure you have installed [DevPod](./install.mdx) on your system.
 Navigate to 'Workspaces' > '+ Create'. Enter your project url or choose one of the quickstart examples. 
 
 <figure>
-<img src="/docs/media/create-workspace-repo.png" alt="DevPod Flow" />
+<img src={require("@site/static/media/create-workspace-repo.png").default} alt="DevPod Flow" />
   <figcaption>Create Workspace</figcaption>
 </figure>
 
 Make sure to select 'None' under 'Default IDE'
 
 <figure>
-  <img src="/docs/media/create-workspace-ssh.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-ssh.png").default} alt="DevPod Flow" />
   <figcaption>Select IDE</figcaption>
 </figure>
 
 Then press 'Create Workspace'.
 
 <figure>
-  <img src="/docs/media/create-workspace-final-ssh.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-final-ssh.png").default} alt="DevPod Flow" />
   <figcaption>Create Workspace</figcaption>
 </figure>
 

docs/pages/getting-started/quickstart-vim.mdx

@@ -18,21 +18,21 @@ Make sure you have installed [DevPod](./install.mdx) on your system.
 Navigate to 'Workspaces' > '+ Create'. Enter your project url or choose one of the quickstart examples. 
 
 <figure>
-<img src="/docs/media/create-workspace-repo.png" alt="DevPod Flow" />
+<img src={require("@site/static/media/create-workspace-repo.png").default} alt="DevPod Flow" />
   <figcaption>Create Workspace</figcaption>
 </figure>
 
 Make sure to select 'None' under 'Default IDE'
 
 <figure>
-  <img src="/docs/media/create-workspace-vim.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-vim.png").default} alt="DevPod Flow" />
   <figcaption>Select IDE</figcaption>
 </figure>
 
 Then press 'Create Workspace'.
 
 <figure>
-  <img src="/docs/media/create-workspace-final-vim.png" alt="DevPod Flow" />
+  <img src={require("@site/static/media/create-workspace-final-vim.png").default} alt="DevPod Flow" />
   <figcaption>Create Workspace</figcaption>
 </figure>