From 5a5bc2bdd7fb05ccc36c2dbe3b8de17fe5d3587f Mon Sep 17 00:00:00 2001 From: Lennart Date: Thu, 21 Oct 2021 12:19:39 +0200 Subject: [PATCH] chore(gatsby): Update README (#33615) --- README.md | 19 +++++++++++-------- packages/gatsby/README.md | 38 +++++++++++++++++++++----------------- 2 files changed, 32 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index bed5c1fe77bd7..b04ebac941c61 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

- Gatsby v3 + Gatsby v4

@@ -12,11 +12,11 @@

- Fast in every way that matters + Static. That. Scales.

- Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps + Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps.
It combines the control and scalability of dynamically rendered sites with the speed of static-site generation, creating a whole new web of possibilities.

@@ -66,6 +66,8 @@ Gatsby is a modern web framework for blazing fast websites. limitations. Gatsby sites are fully functional React apps, so you can create high-quality, dynamic web apps, from blogs to e-commerce sites to user dashboards. +- **Choose your Rendering Option.** You can choose alternative [rendering options](https://gatsbyjs.com/docs/conceptual/rendering-options/), namely Deferred Static Generation (DSG) and Server-Side Rendering (SSR), in addition to Static Site Generation (SSG) β€” on a per-page basis. This type of granular control allows you to optimize for performance and productivity without sacrificing one for the other. + - **Use a Modern Stack for Every Site.** No matter where the data comes from, Gatsby sites are built using React and GraphQL. Build a uniform workflow for you and your team, regardless of whether the data is coming from the same backend. @@ -88,6 +90,7 @@ Gatsby is a modern web framework for blazing fast websites. - [Get Up and Running in 5 Minutes](#-get-up-and-running-in-5-minutes) - [Learning Gatsby](#-learning-gatsby) +- [Release Notes](#-release-notes) - [Migration Guides](#-migration-guides) - [How to Contribute](#-how-to-contribute) - [License](#-license) @@ -146,10 +149,10 @@ Wondering what we've shipped recently? Check out our [release notes](https://www ## πŸ’Ό Migration Guides -Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v3 to your site without starting from scratch! +Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v4 to your site without starting from scratch! +- [Migrate from v3 to v4](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v3-to-v4/) - [Migrate from v2 to v3](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/) -- [Migrate from v1 to v2](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v1-to-v2/) ## ❗ Code of Conduct @@ -157,7 +160,7 @@ Gatsby is dedicated to building a welcoming, diverse, safe community. We expect ## 🀝 How to Contribute -Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! :muscle::purple_heart: +Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how-to-contribute/) for ideas on contributing and setup steps for getting our repositories up and running on your local machine. @@ -165,9 +168,9 @@ Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](https://github.com/gatsbyjs/gatsby/tree/master/packages) managed in this codebase, even though we publish them to NPM as separate packages. -### Contributing to Gatsby v2 +### Contributing to Gatsby v3 -We are only accepting critical security patches for Gatsby v2. +We are only accepting critical security patches for Gatsby v3. ## πŸ“ License diff --git a/packages/gatsby/README.md b/packages/gatsby/README.md index 685a9777027a7..b04ebac941c61 100644 --- a/packages/gatsby/README.md +++ b/packages/gatsby/README.md @@ -4,17 +4,19 @@

- Gatsby v3 + Gatsby v4

-

+

βš›οΈ πŸ“„ πŸš€ -

-

- Fast in every way that matters -

+

+

+ + Static. That. Scales. + +

- Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps + Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps.
It combines the control and scalability of dynamically rendered sites with the speed of static-site generation, creating a whole new web of possibilities.

@@ -40,7 +42,7 @@

-

+

Quickstart Β· Tutorial @@ -56,14 +58,16 @@ Support: Twitter, Discussions & Discord -

+ Gatsby is a modern web framework for blazing fast websites. - **Go Beyond Static Websites.** Get all the benefits of static websites with none of the - limitations. Gatsby sites are fully functional React apps so you can create high-quality, + limitations. Gatsby sites are fully functional React apps, so you can create high-quality, dynamic web apps, from blogs to e-commerce sites to user dashboards. +- **Choose your Rendering Option.** You can choose alternative [rendering options](https://gatsbyjs.com/docs/conceptual/rendering-options/), namely Deferred Static Generation (DSG) and Server-Side Rendering (SSR), in addition to Static Site Generation (SSG) β€” on a per-page basis. This type of granular control allows you to optimize for performance and productivity without sacrificing one for the other. + - **Use a Modern Stack for Every Site.** No matter where the data comes from, Gatsby sites are built using React and GraphQL. Build a uniform workflow for you and your team, regardless of whether the data is coming from the same backend. @@ -76,7 +80,7 @@ Gatsby is a modern web framework for blazing fast websites. splitting, image optimization, inlining critical styles, lazy-loading, prefetching resources, and more to ensure your site is fast β€” no manual tuning required. -- **Host at Scale for Pennies.** Gatsby sites don’t require servers so you can host your entire +- **Host at Scale for Pennies.** Gatsby sites don’t require servers, so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be hosted entirely free on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/) and other similar services. @@ -86,6 +90,7 @@ Gatsby is a modern web framework for blazing fast websites. - [Get Up and Running in 5 Minutes](#-get-up-and-running-in-5-minutes) - [Learning Gatsby](#-learning-gatsby) +- [Release Notes](#-release-notes) - [Migration Guides](#-migration-guides) - [How to Contribute](#-how-to-contribute) - [License](#-license) @@ -99,7 +104,6 @@ You can get a new Gatsby site up and running on your local dev environment in 5 ```shell npm install -g gatsby-cli - ``` 2. **Create a Gatsby site from a Gatsby starter.** @@ -145,10 +149,10 @@ Wondering what we've shipped recently? Check out our [release notes](https://www ## πŸ’Ό Migration Guides -Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v3 to your site without starting from scratch! +Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v4 to your site without starting from scratch! +- [Migrate from v3 to v4](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v3-to-v4/) - [Migrate from v2 to v3](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v2-to-v3/) -- [Migrate from v1 to v2](https://www.gatsbyjs.com/docs/reference/release-notes/migrating-from-v1-to-v2/) ## ❗ Code of Conduct @@ -156,7 +160,7 @@ Gatsby is dedicated to building a welcoming, diverse, safe community. We expect ## 🀝 How to Contribute -Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! :muscle::purple_heart: +Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how-to-contribute/) for ideas on contributing and setup steps for getting our repositories up and running on your local machine. @@ -164,9 +168,9 @@ Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](https://github.com/gatsbyjs/gatsby/tree/master/packages) managed in this codebase, even though we publish them to NPM as separate packages. -### Contributing to Gatsby v2 +### Contributing to Gatsby v3 -We are only accepting critical security patches for Gatsby v2. +We are only accepting critical security patches for Gatsby v3. ## πŸ“ License