From 1f9e4857ff2b2cb7db89d619618cdf546cd3b3dc Mon Sep 17 00:00:00 2001 From: Chris Swithinbank Date: Fri, 8 Jul 2022 21:56:24 +0200 Subject: [PATCH] Integration README fixes (#3865) * Remove stray XML tag in sitemap integration README * Fix link errors * Add changeset --- .changeset/breezy-ravens-sort.md | 11 +++++++++++ packages/integrations/deno/README.md | 2 +- packages/integrations/image/README.md | 2 +- packages/integrations/netlify/README.md | 4 ++-- packages/integrations/node/README.md | 2 +- packages/integrations/prefetch/README.md | 1 - packages/integrations/sitemap/README.md | 1 - packages/integrations/vercel/README.md | 2 +- 8 files changed, 17 insertions(+), 8 deletions(-) create mode 100644 .changeset/breezy-ravens-sort.md diff --git a/.changeset/breezy-ravens-sort.md b/.changeset/breezy-ravens-sort.md new file mode 100644 index 000000000000..591979af30a7 --- /dev/null +++ b/.changeset/breezy-ravens-sort.md @@ -0,0 +1,11 @@ +--- +'@astrojs/deno': patch +'@astrojs/image': patch +'@astrojs/netlify': patch +'@astrojs/node': patch +'@astrojs/prefetch': patch +'@astrojs/sitemap': patch +'@astrojs/vercel': patch +--- + +Small README fixes diff --git a/packages/integrations/deno/README.md b/packages/integrations/deno/README.md index d0ce1e8f2728..2b9b4716cad7 100644 --- a/packages/integrations/deno/README.md +++ b/packages/integrations/deno/README.md @@ -42,7 +42,7 @@ export default defineConfig({ ## Usage -After [performing a build](https://docs.astro.build/en/guides/deploy/#building-the-app) there will be a `dist/server/entry.mjs` module. You can start a server by importing this module in your Deno app: +After [performing a build](https://docs.astro.build/en/guides/deploy/#building-your-site-locally) there will be a `dist/server/entry.mjs` module. You can start a server by importing this module in your Deno app: ```js import './dist/entry.mjs'; diff --git a/packages/integrations/image/README.md b/packages/integrations/image/README.md index b1ddee8ac80b..be1abc65676e 100644 --- a/packages/integrations/image/README.md +++ b/packages/integrations/image/README.md @@ -4,7 +4,7 @@ This **[Astro integration][astro-integration]** makes it easy to optimize images in your [Astro project](https://astro.build), with full support for SSG builds and server-side rendering! -- [Why `@astrojs/image`?](#why-astrojs-image) +- [Why `@astrojs/image`?](#why-astrojsimage) - [Installation](#installation) - [Usage](#usage) - [Configuration](#configuration) diff --git a/packages/integrations/netlify/README.md b/packages/integrations/netlify/README.md index a669227af8e8..b34c3ba535e5 100644 --- a/packages/integrations/netlify/README.md +++ b/packages/integrations/netlify/README.md @@ -56,9 +56,9 @@ export default defineConfig({ ``` ## Usage -[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/vercel) +[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/netlify/) -After [performing a build](https://docs.astro.build/en/guides/deploy/#building-the-app) the `netlify/` folder will contain [Netlify Functions](https://docs.netlify.com/functions/overview/) in the `netlify/functions/` folder. +After [performing a build](https://docs.astro.build/en/guides/deploy/#building-your-site-locally) the `netlify/` folder will contain [Netlify Functions](https://docs.netlify.com/functions/overview/) in the `netlify/functions/` folder. Now you can deploy. Install the [Netlify CLI](https://docs.netlify.com/cli/get-started/) and run: diff --git a/packages/integrations/node/README.md b/packages/integrations/node/README.md index a31466cf7d4b..4652b3dfd1ee 100644 --- a/packages/integrations/node/README.md +++ b/packages/integrations/node/README.md @@ -43,7 +43,7 @@ export default defineConfig({ ## Usage -After [performing a build](https://docs.astro.build/en/guides/deploy/#building-the-app) there will be a `dist/server/entry.mjs` module that exposes a `handler` function. This works like a [middleware](https://expressjs.com/en/guide/using-middleware.html) function: it can handle incoming requests and respond accordingly. +After [performing a build](https://docs.astro.build/en/guides/deploy/#building-your-site-locally) there will be a `dist/server/entry.mjs` module that exposes a `handler` function. This works like a [middleware](https://expressjs.com/en/guide/using-middleware.html) function: it can handle incoming requests and respond accordingly. ### Using a middleware framework diff --git a/packages/integrations/prefetch/README.md b/packages/integrations/prefetch/README.md index c7a50b9566f9..c97ce076e693 100644 --- a/packages/integrations/prefetch/README.md +++ b/packages/integrations/prefetch/README.md @@ -7,7 +7,6 @@ - [Examples](#examples) - [Troubleshooting](#troubleshooting) - [Contributing](#contributing) -- [Changelog](#changelog) ## Why Prefetch? diff --git a/packages/integrations/sitemap/README.md b/packages/integrations/sitemap/README.md index 7fffe52e2c3f..755f84d9cd4c 100644 --- a/packages/integrations/sitemap/README.md +++ b/packages/integrations/sitemap/README.md @@ -109,7 +109,6 @@ Example of generated sitemap content for a two-page website: ``` **sitemap-0.xml** - ```xml diff --git a/packages/integrations/vercel/README.md b/packages/integrations/vercel/README.md index dd7d0679dec6..e58b7c4b81df 100644 --- a/packages/integrations/vercel/README.md +++ b/packages/integrations/vercel/README.md @@ -59,7 +59,7 @@ import vercel from '@astrojs/vercel/static'; ## Usage -📚 **[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/vercel)** +📚 **[Read the full deployment guide here.](https://docs.astro.build/en/guides/deploy/vercel/)** You can deploy by CLI (`vercel deploy`) or by connecting your new repo in the [Vercel Dashboard](https://vercel.com/). Alternatively, you can create a production build locally: