change by-example name to examples (denoland#706)

dandv · Aug 13, 2024 · aa20d00 · aa20d00
1 parent 0f6b253
commit aa20d00
Show file tree

Hide file tree

Showing 73 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ The actual content of the docs site is found mostly in these folders:
 - `runtime` - docs for the Deno CLI / runtime
 - `deploy` - docs for the Deno Deploy cloud service
 - `subhosting` - docs for Deno Subhosting
-- `by-example` - docs for the [Examples](#Examples) section
+- `examples` - docs for the [Examples](#Examples) section
 
 Most files are [markdown](https://lume.land/plugins/markdown/), but even
 markdown files are processed with [MDX](https://mdxjs.com/), which enables you
@@ -123,7 +123,7 @@ snippets showcasing various functions of the APIs implemented in Deno.
 
 ### Adding an example
 
-To add an example, create a file in the `by-example` directory. The file name
+To add an example, create a file in the `examples` directory. The file name
 should be a short description of the example (in kebab case) and the contents
 should be the code for the example. The file should be in the `.ts` format. The
 file should start with a JSDoc style multi line comment that describes the

diff --git a/_config.ts b/_config.ts
@@ -81,7 +81,7 @@ site.copy("deno.json");
 site.copy("go.json");
 site.copy("server.ts");
 site.copy("middleware.ts");
-site.copy("by-example");
+site.copy("examples");
 
 site.use(redirects({
   output: "json",
@@ -214,7 +214,7 @@ site.ignore(
   "README.md",
   (path) => path.match(/\/reference_gen.*.ts/) !== null,
   (path) => path.includes("/reference_gen/node_modules"),
-  "by-example",
+  "examples",
   // "deploy",
   // "examples.page.tsx",
   // "runtime",

diff --git a/examples.page.tsx b/examples.page.tsx
@@ -34,7 +34,7 @@ export const sidebar = [
 ];
 
 export default function* (_data: Lume.Data, helpers: Lume.Helpers) {
-  const files = [...walkSync("./by-example/", {
+  const files = [...walkSync("./examples/", {
     exts: [".ts"],
   })];
   const examples = files.map((file) => {
@@ -54,10 +54,10 @@ export default function* (_data: Lume.Data, helpers: Lume.Helpers) {
     ).join("\n");
 
     const url =
-      `https://github.com/denoland/deno-docs/blob/main/by-example/${example.name}${
+      `https://github.com/denoland/deno-docs/blob/main/examples/${example.name}${
         example.parsed.files.length > 1 ? "/main" : ""
       }`;
-    const rawUrl = `https://docs.deno.com/by-example/${example.name}${
+    const rawUrl = `https://docs.deno.com/examples/${example.name}${
       example.parsed.files.length > 1 ? "/main" : ""
     }`;
 

diff --git a/by-example/benchmarking.ts → examples/benchmarking.ts b/by-example/benchmarking.ts → examples/benchmarking.ts
diff --git a/by-example/byte-manipulation.ts → examples/byte-manipulation.ts b/by-example/byte-manipulation.ts → examples/byte-manipulation.ts
diff --git a/by-example/checking-file-existence.ts → examples/checking-file-existence.ts b/by-example/checking-file-existence.ts → examples/checking-file-existence.ts
diff --git a/by-example/color-logging.ts → examples/color-logging.ts b/by-example/color-logging.ts → examples/color-logging.ts
diff --git a/by-example/command-line-arguments.ts → examples/command-line-arguments.ts b/by-example/command-line-arguments.ts → examples/command-line-arguments.ts
diff --git a/by-example/create-remove-directories.ts → examples/create-remove-directories.ts b/by-example/create-remove-directories.ts → examples/create-remove-directories.ts
diff --git a/by-example/cron.ts → examples/cron.ts b/by-example/cron.ts → examples/cron.ts
diff --git a/by-example/deleting-files.ts → examples/deleting-files.ts b/by-example/deleting-files.ts → examples/deleting-files.ts
diff --git a/by-example/deno-version.ts → examples/deno-version.ts b/by-example/deno-version.ts → examples/deno-version.ts
diff --git a/by-example/dependency-management.ts → examples/dependency-management.ts b/by-example/dependency-management.ts → examples/dependency-management.ts
diff --git a/by-example/dns-queries.ts → examples/dns-queries.ts b/by-example/dns-queries.ts → examples/dns-queries.ts
diff --git a/by-example/environment-variables.ts → examples/environment-variables.ts b/by-example/environment-variables.ts → examples/environment-variables.ts
diff --git a/by-example/hashing.ts → examples/hashing.ts b/by-example/hashing.ts → examples/hashing.ts
diff --git a/by-example/hello-world.ts → examples/hello-world.ts b/by-example/hello-world.ts → examples/hello-world.ts
diff --git a/by-example/hex-base64-encoding.ts → examples/hex-base64-encoding.ts b/by-example/hex-base64-encoding.ts → examples/hex-base64-encoding.ts
diff --git a/by-example/http-requests.ts → examples/http-requests.ts b/by-example/http-requests.ts → examples/http-requests.ts
diff --git a/by-example/http-server-files.ts → examples/http-server-files.ts b/by-example/http-server-files.ts → examples/http-server-files.ts
diff --git a/by-example/http-server-routing.ts → examples/http-server-routing.ts b/by-example/http-server-routing.ts → examples/http-server-routing.ts
diff --git a/by-example/http-server-streaming.ts → examples/http-server-streaming.ts b/by-example/http-server-streaming.ts → examples/http-server-streaming.ts
diff --git a/by-example/http-server-websocket.ts → examples/http-server-websocket.ts b/by-example/http-server-websocket.ts → examples/http-server-websocket.ts
diff --git a/by-example/http-server.ts → examples/http-server.ts b/by-example/http-server.ts → examples/http-server.ts
diff --git a/by-example/import-export.ts → examples/import-export.ts b/by-example/import-export.ts → examples/import-export.ts
diff --git a/by-example/importing-json.ts → examples/importing-json.ts b/by-example/importing-json.ts → examples/importing-json.ts
diff --git a/by-example/kv-watch.ts → examples/kv-watch.ts b/by-example/kv-watch.ts → examples/kv-watch.ts
diff --git a/by-example/kv.ts → examples/kv.ts b/by-example/kv.ts → examples/kv.ts
diff --git a/by-example/mongo.ts → examples/mongo.ts b/by-example/mongo.ts → examples/mongo.ts
diff --git a/by-example/moving-renaming-files.ts → examples/moving-renaming-files.ts b/by-example/moving-renaming-files.ts → examples/moving-renaming-files.ts
diff --git a/by-example/node.ts → examples/node.ts b/by-example/node.ts → examples/node.ts
diff --git a/by-example/npm.ts → examples/npm.ts b/by-example/npm.ts → examples/npm.ts
diff --git a/by-example/os-signals.ts → examples/os-signals.ts b/by-example/os-signals.ts → examples/os-signals.ts
diff --git a/by-example/parsing-serializing-csv.ts → examples/parsing-serializing-csv.ts b/by-example/parsing-serializing-csv.ts → examples/parsing-serializing-csv.ts
diff --git a/by-example/parsing-serializing-json.ts → examples/parsing-serializing-json.ts b/by-example/parsing-serializing-json.ts → examples/parsing-serializing-json.ts
diff --git a/by-example/parsing-serializing-toml.ts → examples/parsing-serializing-toml.ts b/by-example/parsing-serializing-toml.ts → examples/parsing-serializing-toml.ts
diff --git a/by-example/parsing-serializing-yaml.ts → examples/parsing-serializing-yaml.ts b/by-example/parsing-serializing-yaml.ts → examples/parsing-serializing-yaml.ts
diff --git a/by-example/path-operations.ts → examples/path-operations.ts b/by-example/path-operations.ts → examples/path-operations.ts
diff --git a/by-example/permissions.ts → examples/permissions.ts b/by-example/permissions.ts → examples/permissions.ts
diff --git a/by-example/pid.ts → examples/pid.ts b/by-example/pid.ts → examples/pid.ts
diff --git a/by-example/piping-streams.ts → examples/piping-streams.ts b/by-example/piping-streams.ts → examples/piping-streams.ts
diff --git a/by-example/postgres.ts → examples/postgres.ts b/by-example/postgres.ts → examples/postgres.ts
diff --git a/by-example/prompts.ts → examples/prompts.ts b/by-example/prompts.ts → examples/prompts.ts
diff --git a/by-example/queues.ts → examples/queues.ts b/by-example/queues.ts → examples/queues.ts
diff --git a/by-example/reading-files.ts → examples/reading-files.ts b/by-example/reading-files.ts → examples/reading-files.ts
diff --git a/by-example/redis.ts → examples/redis.ts b/by-example/redis.ts → examples/redis.ts
diff --git a/by-example/streaming-files.ts → examples/streaming-files.ts b/by-example/streaming-files.ts → examples/streaming-files.ts
diff --git a/by-example/subprocesses-output.ts → examples/subprocesses-output.ts b/by-example/subprocesses-output.ts → examples/subprocesses-output.ts
diff --git a/by-example/subprocesses-spawn.ts → examples/subprocesses-spawn.ts b/by-example/subprocesses-spawn.ts → examples/subprocesses-spawn.ts
diff --git a/by-example/symlinks.ts → examples/symlinks.ts b/by-example/symlinks.ts → examples/symlinks.ts
diff --git a/by-example/tcp-connector.ts → examples/tcp-connector.ts b/by-example/tcp-connector.ts → examples/tcp-connector.ts
diff --git a/by-example/tcp-listener.ts → examples/tcp-listener.ts b/by-example/tcp-listener.ts → examples/tcp-listener.ts
diff --git a/by-example/temporary-files.ts → examples/temporary-files.ts b/by-example/temporary-files.ts → examples/temporary-files.ts
diff --git a/by-example/timers.ts → examples/timers.ts b/by-example/timers.ts → examples/timers.ts
diff --git a/by-example/tls-connector.ts → examples/tls-connector.ts b/by-example/tls-connector.ts → examples/tls-connector.ts
diff --git a/by-example/tls-listener.ts → examples/tls-listener.ts b/by-example/tls-listener.ts → examples/tls-listener.ts
diff --git a/by-example/typescript.ts → examples/typescript.ts b/by-example/typescript.ts → examples/typescript.ts
diff --git a/by-example/udp-connector.ts → examples/udp-connector.ts b/by-example/udp-connector.ts → examples/udp-connector.ts
diff --git a/by-example/udp-listener.ts → examples/udp-listener.ts b/by-example/udp-listener.ts → examples/udp-listener.ts
diff --git a/by-example/ulid.ts → examples/ulid.ts b/by-example/ulid.ts → examples/ulid.ts
diff --git a/by-example/url-parsing.ts → examples/url-parsing.ts b/by-example/url-parsing.ts → examples/url-parsing.ts
diff --git a/by-example/uuids.ts → examples/uuids.ts b/by-example/uuids.ts → examples/uuids.ts
diff --git a/by-example/walking-directories.ts → examples/walking-directories.ts b/by-example/walking-directories.ts → examples/walking-directories.ts
diff --git a/by-example/watching-files.ts → examples/watching-files.ts b/by-example/watching-files.ts → examples/watching-files.ts
diff --git a/by-example/web-workers.ts → examples/web-workers.ts b/by-example/web-workers.ts → examples/web-workers.ts
diff --git a/by-example/webassembly.ts → examples/webassembly.ts b/by-example/webassembly.ts → examples/webassembly.ts
diff --git a/by-example/websocket.ts → examples/websocket.ts b/by-example/websocket.ts → examples/websocket.ts
diff --git a/by-example/writing-files.ts → examples/writing-files.ts b/by-example/writing-files.ts → examples/writing-files.ts
diff --git a/by-example/writing-tests.ts → examples/writing-tests.ts b/by-example/writing-tests.ts → examples/writing-tests.ts
diff --git a/orama.ts b/orama.ts
@@ -102,7 +102,7 @@ export async function generateDocumentsForSymbols(): Promise<OramaDocument[]> {
 }
 
 export async function generateDocumentsForExamples(): Promise<OramaDocument[]> {
-  const files = [...walkSync("./by-example/", {
+  const files = [...walkSync("./examples/", {
     exts: [".ts"],
   })];
   return await Promise.all(files.map(async (file) => {

diff --git a/runtime/manual/runtime/builtin_apis.md b/runtime/manual/runtime/builtin_apis.md
@@ -21,7 +21,7 @@ to the file system.
 Refer to the links below for code examples of how to use the file system
 functions.
 
-- [Reading files in several different ways](https://examples.deno.land/reading-files)
+- [Reading files in several different ways](https://docs.deno.com/examples/reading-files)
 - [Reading files in streams](../../tutorials/file_server.md)
 - [Reading a text file (`Deno.readTextFile`)](../../tutorials/read_write_files.md#reading-a-text-file)
 - [Writing a text file (`Deno.writeTextFile`)](../../tutorials/read_write_files.md#writing-a-text-file)

diff --git a/runtime/manual/tools/run.md b/runtime/manual/tools/run.md
@@ -7,11 +7,11 @@ title: "`deno run`, run a file"
 ## Usage
 
 To run the file at
-[https://examples.deno.land/hello-world.ts](https://examples.deno.land/hello-world.ts)
+[https://docs.deno.com/examples/hello-world.ts](https://docs.deno.com/examples/hello-world.ts)
 use:
 
 ```console
-deno run https://examples.deno.land/hello-world.ts
+deno run https://docs.deno.com/examples/hello-world.ts
 ```
 
 You can also run files locally. Ensure that you are in the correct directory and
@@ -76,7 +76,7 @@ command.
 You can pipe code from stdin and run it immediately with:
 
 ```console
-curl https://examples.deno.land/hello-world.ts | deno run -
+curl https://docs.deno.com/examples/hello-world.ts | deno run -
 ```
 
 ## Terminate run

diff --git a/runtime/tutorials/index.md b/runtime/tutorials/index.md
@@ -42,4 +42,4 @@ runtime.
 - [Vue](./how_to_with_npm/vue.md)
 
 Additional examples can by found at
-[Deno by Example](https://examples.deno.land/).
+[Deno by Example](https://docs.deno.com/examples/).