Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): migrate cloud docs to dotcom(1) #36452

Merged
merged 39 commits into from
Sep 5, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
9cce498
push up site creation & node version docs
Aug 12, 2022
d4f287b
migrate doc for apex and subdomains
Aug 12, 2022
168a6a9
migrate doc for netlify trailing slash
Aug 12, 2022
383b70d
move webhook/deploy docs to this branch
Aug 15, 2022
c591ee6
migrate doc for outgoing webhooks
Aug 15, 2022
5ab08a8
Merge branch 'gatsbyjs:master' into docs/add-cloud-docs
littlemarcus Aug 15, 2022
f9a2aab
rerun prettier
Aug 16, 2022
25a6914
rerun prettier
Aug 16, 2022
8812501
Merge branch 'gatsbyjs:master' into docs/add-cloud-docs
littlemarcus Aug 16, 2022
9282ed1
migrate doc for platform limits
Aug 16, 2022
3eae690
format subheaders
Aug 17, 2022
6780294
migrate doc for deploying functions on cloud
Aug 17, 2022
5cb2a1f
fix casing in docs descriptions
Aug 18, 2022
9586c04
remove we/lesson refs & netlify doc
Aug 18, 2022
726ed47
Update docs/docs/how-to/cloud/set-node-version.md
littlemarcus Aug 18, 2022
e9c8f16
Update docs/docs/how-to/cloud/create-site-from-repository.md
littlemarcus Aug 18, 2022
675862d
rework create site from repo doc
Aug 19, 2022
ca5f78c
Merge branch 'docs/add-cloud-docs' of https://github.com/MarcusCole51…
Aug 19, 2022
3e4bd91
additional adjustments
Aug 19, 2022
e02f4cf
match description & file title
Aug 19, 2022
526a2e9
adjust VCS references
Aug 19, 2022
3003230
adjust links/bolding
Aug 21, 2022
29b8aa6
final adjustments
Aug 21, 2022
74eb235
Merge branch 'gatsbyjs:master' into docs/add-cloud-docs1
littlemarcus Aug 21, 2022
eaeea74
Merge branch 'docs/add-cloud-docs' into docs/add-cloud-docs1
Aug 21, 2022
42a9857
next batch
Aug 23, 2022
c63737b
Merge branch 'gatsbyjs:master' into docs/add-cloud-docs1
littlemarcus Aug 23, 2022
6c0767c
additional docs/fixes
Aug 23, 2022
01f40a8
Merge branch 'docs/add-cloud-docs1' of https://github.com/MarcusCole5…
Aug 23, 2022
27140b1
fix linting issues
Aug 23, 2022
9b662f1
Merge branch 'master' into docs/add-cloud-docs1
DSchau Aug 24, 2022
5aafd20
Merge branch 'master' into docs/add-cloud-docs1
littlemarcus Sep 1, 2022
fc5caf1
Update docs/docs/reference/cloud/platform-limits.md
littlemarcus Sep 1, 2022
cb3652f
Update docs/docs/reference/cloud/what-is-gatsby-cloud.md
littlemarcus Sep 1, 2022
06afda1
Update docs/docs/how-to/cloud/managing-workspace-members.md
littlemarcus Sep 1, 2022
3c0477b
Update docs/docs/reference/cloud/build-logs.md
littlemarcus Sep 1, 2022
3d4e524
Update docs/docs/reference/cloud/cms-previews.md
littlemarcus Sep 1, 2022
69f0c95
Update docs/docs/reference/cloud/hosting-and-data-source-integrations.md
littlemarcus Sep 1, 2022
2431043
Update docs/docs/reference/cloud/quick-connect.md
littlemarcus Sep 1, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
additional docs/fixes
  • Loading branch information
“Marcus committed Aug 23, 2022
commit 6c0767c78bff87cf3f611323f8f217d9613a192d
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Creating a Deploy to Gatsby Cloud Button"
title: "Create a Deploy to Gatsby Cloud Button"
description: "Learn how to add a deploy button to your Github repository"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/how-to/cloud/create-site-from-repository.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Create a Site from a Repository"
title: "Create a Site From a Repository"
description: "How to create a Gatsby Cloud site from a repository"
littlemarcus marked this conversation as resolved.
Show resolved Hide resolved
littlemarcus marked this conversation as resolved.
Show resolved Hide resolved
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Functions are a Gatsby core feature and are not specific to Gatsby Cloud. To lea

### Routing in Gatsby Cloud

Functions that are included in a Gatsby project and deployed on Gatsby cloud are available at any build URL. This includes any preview URLs (`gstb.io` domain) or hosting URLs (on `gatsbyjs.io` or your custom domain).
Functions that are included in a Gatsby project and deployed on Gatsby cloud are available at any build URL. This includes any preview URLs (`gstb.io` domain) or hosting URLs (`gatsbyjs.io` or your custom domain).

```javascript:title=src/api/hello-world.js
const sample = (req, res) => {
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/how-to/cloud/deploying-to-firebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ On the “Firebase Integration” screen choose a Firebase project for deploymen

Firebase allows you to configure customized hosting behavior such as redirects, headers, cache settings, and which files to deploy. You can define these behaviors in a `firebase.json` file. See [Deploying to Firebase](/docs/how-to/previews-deploys-hosting/deploying-to-firebase/) for the Gatsby recommended caching settings.

In order for Gatsby Cloud to use these settings for your Firebase hosting, you’ll need to make sure that your `firebase.json` file ends up in your `public/` directory when your build is complete.
In order for Gatsby Cloud to use these settings for your Firebase hosting, you’ll need to make sure that your `firebase.json` file ends up in your `/public` directory when your build is complete.

One way you can accomplish this is by adding the following code to your `gatsby-node.js` file:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/contentful-quick-connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/images/gatsby-cloud-data-sources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/docs/reference/cloud/cms-previews.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ If your site uses a content management system (CMS), Gatsby Cloud provides a too

A "CMS Preview" is a development build of your site that enables you to make changes in your CMS and see those changes take effect in real-time.

Using CMS Previews requires connecting your site to one of the supported CMSs. Check out the [Connecting to a Content Management System](https://support.gatsbyjs.com/hc/en-us/sections/360011112314-Connecting-to-a-Content-Management-System) tutorials for more information on how to configure your site for CMS Previews.
Using CMS Previews requires connecting your site to [one of the supported CMSs](/docs/reference/cloud/hosting-and-data-source-integrations). Check out the [Connecting to a Content Management System](https://support.gatsbyjs.com/hc/en-us/sections/360011112314-Connecting-to-a-Content-Management-System) tutorials for more information on how to configure your site for CMS Previews.

## How CMS Previews are triggered

A CMS Preview build may be triggered when any of the following events occur:

- A change in the connected CMS (such as an autosave while typing, save, or publish action).
- A Git commit to the production branch configured in "Site Settings"
- A Git commit to the production branch configured in "Site Settings."
- Manually clicking the "Trigger Build" or "Restart Preview" button in the Gatsby Cloud user interface.
- A `POST` request to the Preview Webhook.

Expand Down Expand Up @@ -46,7 +46,7 @@ Incremental Previews are those noted with the "CLOUD" badge:

This preview builder is only used where incremental previews are not possible. The build process is similar to `gatsby develop` in local development. It is subject to resource timeouts and the preview will not be available until the next build completes after a timeout occurs.

## Preview Extensions
## Preview extensions

Some CMSs support a preview extension that enables you to view your CMS Preview build without having to leave your CMS. Preview extensions are available for:

Expand Down
48 changes: 48 additions & 0 deletions docs/docs/reference/cloud/hosting-and-data-source-integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: "Hosting and Data Source Integrations"
description: "Review the various hosting and CMS platforms available for integration on Gatsby Cloud"
littlemarcus marked this conversation as resolved.
Show resolved Hide resolved
---

Gatsby Cloud provides integrations for many popular hosting and content management platforms that help make development with Gatsby even more efficient.

## Hosting integrations

Hosting integrations simplify deploying your site to the internet. The following hosting services are officially supported and have automated integrations:

- Azure
- Amazon Web Services S3
- Fastly
- Firebase
- Google Storage
- Netlify
- Vercel

When you set up a hosting integration, your site will automatically be deployed to your chosen service any time a Production Build completes successfully.

## Data source ntegrations

Data source integrations make it easy to connect your site to a content management system (CMS). The following CMS providers are officially supported and can be automatically configured with [Quick Connect](/docs/reference/cloud/quick-connect):

- Contentful
- Cosmic
- DatoCMS
- Sanity

The following CMS providers are also officially supported but require manual configuration:

- Agility
- Contentstack
- Drupal
- Flotiq
- Kontent
- Strapi
- WordPress

Depending on the configuration, whenever you make updates in your CMS, you can automatically trigger Production Builds and CMS Previews for your site.

For details on how to set up a hosting or data source integration, see our [How-To Guides](/docs/how-to/cloud/).





46 changes: 46 additions & 0 deletions docs/docs/reference/cloud/quick-connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: "Quick Connect"
description: "Automatically configure your CMS integration on Gatsby Cloud using Quick Connect"
littlemarcus marked this conversation as resolved.
Show resolved Hide resolved
---

Quick Connect is a Gatsby Cloud feature that handles automatically configuring your content management system (CMS) integration. Quick Connect shows up in three places:

- During the "Integrations" step when creating a site from a repository or template.
- During the "Connect CMS" step when creating a site from a CMS specific template.
- When setting up a data source integration via "Site Settings".

Quick Connect is available for the following CMS providers:

- Contentful
- Cosmic
- DatoCMS
- Sanity
- Shopify

## Connecting during site creation

When creating a site from a CMS specific starter, Quick Connect will bootstrap the entire CMS project required to provide content to the new site. All of the content models, content, webhooks, and environment variables will be configured automatically.

When creating a site from a Gatsby project repository, Quick Connect will prompt you to choose the CMS project to associate the site with. For detailed instructions, see the guide for [connecting to your specific CMS](https://support.gatsbyjs.com/hc/en-us/sections/360011112314-Connecting-to-a-Content-Management-System).

## Connecting using Site Settings

You can set up a data source integration for a site you previously created by going to **"Site Settings > Data Sources"**.

![Data sources available for Quick Connect](../../images/gatsby-cloud-data-sources.png)

Clicking **"Connect"** will start the setup process for the data source integration. You will be prompted to authorize Gatsby Cloud to connect to your CMS by logging in to your CMS account or providing an authentication token.

![Contentful Quick Connect authorization screen](../../images/contentful-quick-connect.png)

Once authorized, Quick Connect will automatically configure webhooks, environment variables, and the preview extension (where applicable) for your CMS.

![Connected Contentful integration](../../images/contentful-connected-integration.png)

Quick Connect assumes some default environment variable names for things like access tokens and project IDs, so you may need to modify them to match the variable names in your project. Again, see the guide for [connecting to your specific CMS](https://support.gatsbyjs.com/hc/en-us/sections/360011112314) for more information. Also, see the [Managing Environment Variables](/docs/reference/cloud/managing-environment-variables/) guide.