Skip to content

Commit

Permalink
docs(en): fix typo + add clarifying punctuation (withastro#2912)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Rainsberger <[email protected]>
  • Loading branch information
PineappleRind and sarah11918 authored Mar 24, 2023
1 parent 8bad900 commit 7723581
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 14 deletions.
5 changes: 2 additions & 3 deletions src/content/docs/en/guides/cms/contentful.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To connect with your Contentful space, install both of the following using the s
</Fragment>
</PackageManagerTabs>

Next, create a new file called `contentful.ts` in `src/lib/` directory in your project.
Next, create a new file called `contentful.ts` in the `src/lib/` directory of your project.

```ts title="src/lib/contentful.ts"
import contentful from "contentful";
Expand Down Expand Up @@ -126,7 +126,7 @@ Finally, your root directory should now include these new files:

### Fetching data

Now, Astro components can fetch your data using the `contentfulClient` and specifying the `content_type` to receive from your Contentful account.
Now, Astro components can fetch data from your Contentful account by using the `contentfulClient` and specifying the `content_type`.

For example, if you have a "blogPost" content type that has a text field for a title and a rich text field for content, your component might look like this:

Expand Down Expand Up @@ -562,4 +562,3 @@ To set up a webhook in Vercel:
In your Contentful space **settings**, click on the **Webhooks** tab and create a new webhook by clicking the **Add Webhook** button. Provide a name for your webhook and paste the webhook URL you copied in the previous section. Finally, hit **Save** to create the webhook.

Now, whenever you publish a new blog post in Contentful, a new build will be triggered and your blog will be updated.

8 changes: 4 additions & 4 deletions src/content/docs/en/guides/cms/storyblok.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'



[Storyblok](https://www.storyblok.com/) is a component based headless CMS that allows you to manage your content using reusable components called Bloks.
[Storyblok](https://www.storyblok.com/) is a component-based headless CMS that allows you to manage your content using reusable components called Bloks.

## Integrating with Astro

Expand Down Expand Up @@ -242,7 +242,7 @@ To create Bloks, go to the Storyblok app and click on the **Block Library** tab.

### Creating content

To add new content, go to the content section by clicking in the **Content** tab. Using the Blok library that you created in the previous step, create the following stories:
To add new content, go to the content section by clicking on the **Content** tab. Using the Blok library that you created in the previous step, create the following stories:

1. `home` - A content type story with the `page` Blok. Inside the `body` field, add a `blogPostList` Blok.

Expand Down Expand Up @@ -300,7 +300,7 @@ const content = renderRichText(blok.content)
</article>
```

`BlogPostList.astro` is a nestable Blok content type component that will render a list of blog posts previews.
`BlogPostList.astro` is a nestable Blok content type component that will render a list of blog post previews.

It uses the `useStoryblokApi` hook to fetch all the stories with the content type of `blogPost`. It uses the `version` query parameter to fetch the draft versions of the stories when in development mode and the published versions when building for production.

Expand Down Expand Up @@ -479,7 +479,7 @@ try {

This file will fetch and render the page data from Storyblok that matches the dynamic `slug` parameter.

Since you are using a redirect to `/404`, create a 404 page in `src/pages`
Since you are using a redirect to `/404`, create a 404 page in `src/pages`:

```astro title="src/pages/404.astro"
<html lang="en">
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/en/guides/deploy/flightcontrol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@ Supports both static and SSR Astro sites.
- `GUI` (all config managed through flightcontrol dashboard) where you will select the `Astro Static` or `Astro SSR` preset
- `flightcontrol.json` ("infrastructure as code" option where all config is in your repo) where you will select an Astro example config, then add it to your codebase as `flightcontrol.json`
1. Adjust any configuration as needed
1. Click "Create Project" and complete any required steps like linking your AWS account.
1. Click "Create Project" and complete any required steps (like linking your AWS account).


### SSR Setup

To deploy with SSR support, make sure you first set up the [`@astro/node`](/en/guides/integrations-guide/node/) adapter. Then, follow the steps above choosing the appropriate configurations for Astro SSR.

To deploy with SSR support, make sure you first set up the [`@astro/node`](/en/guides/integrations-guide/node/) adapter. Then, follow the steps above, choosing the appropriate configurations for Astro SSR.
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/deploy/heroku.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: deploy
i18nReady: true
---

[Heroku](https://www.heroku.com/) is a platform-as-a-service for building, running, and managing modern apps in the cloud. You can deloy an Astro site to Heroku using this guide.
[Heroku](https://www.heroku.com/) is a platform-as-a-service for building, running, and managing modern apps in the cloud. You can deploy an Astro site to Heroku using this guide.
## How to deploy

1. Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli).
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/guides/deploy/microsoft-azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ i18nReady: true

## Prerequisites

To follow this guide you will need:
To follow this guide, you will need:

- An Azure account and a subscription key. You can create a [free Azure account here](https://azure.microsoft.com/free).
- Your app code pushed to [GitHub](https://github.com/).
Expand All @@ -21,6 +21,6 @@ To follow this guide you will need:

2. Open the Static Web Apps extension, sign in to Azure, and click the **+** button to create a new Static Web App. You will be prompted to designate which subscription key to use.

3. Follow the wizard started by the extension to give your app a name, choose a framework preset, and designate the app root (usually `/`) and built file location `/dist`. The wizard will run and will create a [GitHub Action](https://github.com/features/actions) in your repo in a `.github` folder.
3. Follow the wizard started by the extension to give your app a name, choose a framework preset, and designate the app root (usually `/`) and built file location `/dist`. The wizard will run and will create a [GitHub Action](https://github.com/features/actions) in the `.github` folder of your repo. (This folder will be automatically created if it does not already exist.)

The GitHub Action will deploy your app (you can see its progress in your repo’s Actions tab on GitHub). When successfully completed, you can view your app at the address shown in the SWA Extension’s progress window by clicking the **Browse Website** button (this will appear after the GitHub Action has run).
2 changes: 1 addition & 1 deletion src/content/docs/en/guides/deploy/surge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: deploy
i18nReady: true
---

You can deploy your Astro project to [Surge](https://surge.sh/) a single-command web publishing platform designed for front-end developers.
You can deploy your Astro project to [Surge](https://surge.sh/), a single-command web publishing platform designed for front-end developers.

## How to deploy

Expand Down

0 comments on commit 7723581

Please sign in to comment.