Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.

Fix readme #282

Merged
merged 4 commits into from
Feb 11, 2022
Merged

Fix readme #282

merged 4 commits into from
Feb 11, 2022

Conversation

soupette
Copy link
Contributor

Add documentation on how to set up Gatsby cloud

Signed-off-by: soupette <cyril@strapi.io>
Copy link
Contributor

@remidej remidej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few formatting changes. I sounds like this plugin will be awesome :)

README.md Outdated
- In the Site settings, Environment variables fill the:
- Build variables with the following:
- STRAPI_API_URL with the url of your deployed Strapi application
- STRAPI_TOKEN with your build API TOKEN
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to uppercase TOKEN everytime in API token? Our docs don't do it

README.md Outdated

At this point each time you create an entry the webhooks will trigger a new build a deploy your new Gatsby site.

- In the Site settings, Environment variables fill the:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the - is required before "In the Site settings". It pushes everything one indentation level too deep

README.md Outdated

#### Configurations

Once the plugin is installed you will need to configure it in the plugin's settings section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once the plugin is installed you will need to configure it in the plugin's settings section.
Once the plugin is installed, you will need to configure it in the plugin's settings section.

README.md Outdated
Once the plugin is installed you will need to configure it in the plugin's settings section.

- In the Collection types or the Single Types tab enable when enabling the **preview** it will inject a button in the content manager edit view of the corresponding collection type. So, after creating an entry (draft or published) when clicking on the **Open Gatsby preview** button you will be redirected to the Gatsby preview page
- In the Settings tab enter the Gatsby Content Sync URL which you can find in Gatsby cloud, site settings, Content Sync.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- In the Settings tab enter the Gatsby Content Sync URL which you can find in Gatsby cloud, site settings, Content Sync.
- In the Settings tab, enter the Gatsby Content Sync URL. You can find it in Gatsby cloud, under "Site settings" and "Content Sync".

README.md Outdated

Once the plugin is installed you will need to configure it in the plugin's settings section.

- In the Collection types or the Single Types tab enable when enabling the **preview** it will inject a button in the content manager edit view of the corresponding collection type. So, after creating an entry (draft or published) when clicking on the **Open Gatsby preview** button you will be redirected to the Gatsby preview page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- In the Collection types or the Single Types tab enable when enabling the **preview** it will inject a button in the content manager edit view of the corresponding collection type. So, after creating an entry (draft or published) when clicking on the **Open Gatsby preview** button you will be redirected to the Gatsby preview page
- In the Collection types or the Single Types tab, when enabling the **preview**, it will inject a button in the content manager edit view of the corresponding content type. So, after creating an entry (draft or published), clicking on the **Open Gatsby preview** button will redirect you to the Gatsby preview page.

Signed-off-by: soupette <cyril@strapi.io>
@soupette soupette merged commit 1fde793 into init-migration Feb 11, 2022
@soupette soupette deleted the fix-readme branch February 11, 2022 10:09
@remidej remidej modified the milestone: 2.0.0 Mar 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants