Merge pull request #567 from aluzzardi/docs-improvements

docs: tooling restructuring

.dagger/env/docs/plan/main.cue

@@ -12,8 +12,8 @@ repository: dagger.#Artifact @dagger(input)
 // Build the docs website
 docs: yarn.#Package & {
 	source:   repository
-	cwd:      "tools/daggosaurus/"
-	buildDir: "tools/daggosaurus/build"
+	cwd:      "website/"
+	buildDir: "website/build"
 }
 
 // Deploy the docs website

.github/dependabot.yml

@@ -9,6 +9,6 @@ updates:
     schedule:
       interval: "daily"
   - package-ecosystem: "npm"
-    directory: "/tools/daggosaurus"
+    directory: "/website"
     schedule:
       interval: "daily"

Makefile

@@ -52,5 +52,5 @@ install: dagger
 
 .PHONY: docs
 docs:
-	yarn --cwd "./tools/daggosaurus" install
-	yarn --cwd "./tools/daggosaurus" start
+	yarn --cwd "./website" install
+	yarn --cwd "./website" start

netlify.toml

@@ -1,6 +1,18 @@
 [build]
-  base = "tools/daggosaurus/"
+  base = "website/"
   publish = "build/"
   command = "yarn build"
-  # build only if there are changes within daggosaurus or docs directories.
-  ignore = "[ $BRANCH != main ] && git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../../docs/"
+
+[context.production]
+  # Do not build the site if there's no site-related changes since the last
+  # commit.
+  # This assumes PRs to `main` only contain merge commits, so it's safe to
+  # compare the current commit to the previous.
+  # We can't use `$CACHED_COMMIT_REF` because that points to the PR preview
+  # that was built before merging.
+  ignore = "git diff --quiet HEAD^ HEAD -- . ../docs/ ../netlify.toml"
+
+[context.deploy-preview]
+  # Do not build the site if there's no site-related changes since the last
+  # deploy.
+  ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../docs/ ../netlify.toml"

tools/daggosaurus/custom_plugins/index.js

@@ -1,12 +0,0 @@
-module.exports = function (context, options) {
-    return {
-        name: "custom-docusaurus-plugin",
-        configureWebpack(config, isServer, utils) {
-            return {
-                resolve: {
-                    symlinks: false
-                }
-            };
-        }
-    };
-};

tools/daggosaurus/docs

@@ -1 +0,0 @@
-../../docs

website/docs

@@ -0,0 +1 @@
+../docs

website/docusaurus.config.js

@@ -47,6 +47,7 @@ module.exports = {
       "@docusaurus/preset-classic",
       {
         docs: {
+          path: "../docs",
           sidebarPath: require.resolve("./sidebars.js"),
           editUrl: "https://github.com/dagger/dagger/blob/main",
           routeBasePath: "/",
@@ -57,8 +58,5 @@ module.exports = {
       },
     ],
   ],
-  plugins: [
-    'docusaurus-plugin-sass',
-    path.resolve(__dirname, "./custom_plugins")
-  ],
+  plugins: ["docusaurus-plugin-sass"],
 };

website/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "daggosaurus",
+  "name": "dagger-docs",
   "version": "0.0.0",
   "private": true,
   "scripts": {