merge with main

Author: thisisjofrank

.github/workflows/ci.yml

@@ -1,13 +1,13 @@
-name: Deploy
+name: Lint
 on:
   push:
     branches: main
   pull_request:
     branches: main
 
 jobs:
-  deploy:
-    name: Deploy
+  lint:
+    name: lint and link check
     runs-on: ubuntu-22.04-xl
     permissions:
       id-token: write # Needed for auth with Deno Deploy
@@ -22,6 +22,9 @@ jobs:
         with:
           cache: true
 
+      - run: deno fmt --check
+      - run: deno task test
+
       - name: "Reference: install"
         working-directory: "reference_gen"
         run: deno install
@@ -41,28 +44,10 @@ jobs:
           ORAMA_PRIVATE_API_KEY: ${{ secrets.ORAMA_PRIVATE_API_KEY }}
         run: deno task build
 
-      - name: Generate and upload search index
-        env:
-          ORAMA_PROJECT_ID: ${{ vars.ORAMA_PROJECT_ID }}
-          ORAMA_DATASOURCE_ID: ${{ vars.ORAMA_DATASOURCE_ID }}
-          ORAMA_PRIVATE_API_KEY: ${{ secrets.ORAMA_PRIVATE_API_KEY }}
-        run: |
-          echo "Generating search index..."
-          deno task generate:search
-          echo "Uploading search index to Orama Cloud..."
-          deno task search:upload
-
       - name: Run server
         run: deno run --allow-read=. --allow-net --allow-env --lock=deno.lock server.ts &
 
       - name: Link checker
         env:
           DOCS_ROOT: "http://localhost:8000"
         run: deno run --no-lock --allow-net --allow-env .github/workflows/better_link_checker.ts
-
-      - name: Upload to Deno Deploy
-        uses: denoland/deployctl@v1
-        with:
-          project: "deno-docs"
-          entrypoint: "server.ts"
-          root: "."

.github/workflows/deploy.yml .github/workflows/lint.yml.github/workflows/deploy.yml renamed to .github/workflows/lint.yml

@@ -32,7 +32,7 @@ cliCommandsReferenceFile.writeJsonPrettySync(
   JSON.parse(new TextDecoder().decode(jsonReference.outputSync().stdout)),
 );
 
-await $`deno task update_lint_rules`;
+await $`deno task lint:update`;
 
 if (Deno.args.includes("--create-pr")) {
   await tryCreatePr();

.github/workflows/update_versions.ts

@@ -174,10 +174,10 @@ number of versions they need to think about), improve search indexing, and help
 us maintain the docs by keeping our build times faster.
 
 In general, we should only version the documentation **when we want to
-concurrently maintain several versions of the docs**, like for major/LTS
-versions. For example - the [Node.js docs](https://nodejs.org/en/docs) are only
-versioned for major releases, like `20.x` and `19.x`. We will adopt this pattern
-as well, and won't have versioned docs for patch or feature releases.
+concurrently maintain several versions of the docs**, like for major versions.
+For example - the [Node.js docs](https://nodejs.org/en/docs) are only versioned
+for major releases, like `20.x` and `19.x`. We will adopt this pattern as well,
+and won't have versioned docs for patch or feature releases.
 
 For additive changes, it should usually be sufficient to indicate which version
 a feature or API was released in. For example - in the Node 20 docs, the

README.md

@@ -1,7 +1,9 @@
 type AdmonitionType =
   | "note"
+  | "info"
+  | "tip"
   | "caution"
-  | "tip";
+  | "warning";
 
 export default function Admonition(
   props: { type: AdmonitionType; children: any },

_components/Admonition.tsx

@@ -0,0 +1,35 @@
+export default function EditThisPage({ file }: { file: string | undefined }) {
+  if (!file) {
+    return null;
+  }
+
+  const githubPath = "https://github.com/denoland/docs/edit/main" + file;
+
+  return (
+    <a
+      class="btn"
+      target="_blank"
+      href={githubPath}
+    >
+      Edit this page
+
+      <svg
+        width="98"
+        height="96"
+        xmlns="http://www.w3.org/2000/svg"
+        aria-hidden="true"
+        focusable="false"
+        fill="currentColor"
+        style="display:inline-block;user-select:none;vertical-align:text-bottom;"
+        viewBox="0 0 98 96"
+      >
+        <path
+          fill-rule="evenodd"
+          clip-rule="evenodd"
+          d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z"
+          fill="currentColor"
+        />
+      </svg>
+    </a>
+  );
+}

_components/Breadcrumbs.tsx

@@ -1,8 +1,9 @@
+import EditThisPage from "./EditThisPage.tsx";
+
 export default function Feedback({ file }: { file: string | undefined }) {
   if (!file) {
     return <></>;
   } else {
-    const githubPath = "https://github.com/denoland/docs/edit/main" + file;
     return (
       <section
         id="feedback-section"
@@ -68,31 +69,7 @@ export default function Feedback({ file }: { file: string | undefined }) {
                       </path>
                     </svg>
                   </label>
-                  <a
-                    class="btn"
-                    target="_blank"
-                    href={githubPath}
-                  >
-                    Edit this page
-
-                    <svg
-                      width="98"
-                      height="96"
-                      xmlns="http://www.w3.org/2000/svg"
-                      aria-hidden="true"
-                      focusable="false"
-                      fill="currentColor"
-                      style="display:inline-block;user-select:none;vertical-align:text-bottom;"
-                      viewBox="0 0 98 96"
-                    >
-                      <path
-                        fill-rule="evenodd"
-                        clip-rule="evenodd"
-                        d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z"
-                        fill="currentColor"
-                      />
-                    </svg>
-                  </a>
+                  {!file.includes("[") && <EditThisPage file={file} />}
                 </div>
                 <div
                   id="feedback-more"
@@ -140,7 +117,7 @@ export default function Feedback({ file }: { file: string | undefined }) {
                 rel=""
                 class="mt-4 !underline underline-offset-2 text-xs block"
                 target="_blank"
-                href="/deploy/manual/privacy-policy"
+                href="/deploy/privacy_policy"
               >
                 Privacy policy
               </a>

_components/EditThisPage.tsx

@@ -67,12 +67,12 @@ const data = [
     title: "Services Docs",
     items: [
       {
-        label: "Deno Deploy <sup>EA</sup>",
-        to: "/deploy/early-access/",
+        label: "Deno Deploy ",
+        to: "/deploy/",
       },
       {
         label: "Deno Deploy Classic",
-        to: "/deploy/manual/",
+        to: "/deploy/classic/",
       },
       {
         label: "Deno Subhosting",
@@ -145,17 +145,13 @@ const data = [
         label: "Blog",
         href: "https://deno.com/blog",
       },
-      {
-        label: "Careers",
-        href: "https://deno.com/jobs",
-      },
       {
         label: "Merch",
         href: "https://merch.deno.com/",
       },
       {
         label: "Privacy Policy",
-        href: "/deploy/manual/privacy-policy",
+        href: "/deploy/privacy_policy",
       },
     ],
   },

_components/Feedback.tsx

@@ -11,7 +11,7 @@ export default function (
   const hrefIsInCurrentSection = (href: string, currentSection: string) => {
     return href.includes(currentSection) ||
       href === "/services/" &&
-        ["deploy", "subhosting", "services"].includes(
+        ["deploy", "subhosting", "services", "sandboxes"].includes(
           currentSection,
         );
   };