From 69f538a870fcf75223916fdf074177966119a22b Mon Sep 17 00:00:00 2001 From: Janson Hartliep Date: Tue, 2 Mar 2021 03:35:35 -0500 Subject: [PATCH] chore(docs): update readme (#29837) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updated project main page to reference v3 * removed mention of contributing to v1, changed to referencing bug fixes only for v2 * Update README.md * Update README.md * Update README.md * Update npm package readme Aligns the npm package readme as carbon-copy of main repo. * Reworks the thank you. Lightly reworked—mind you. Co-authored-by: pragmaticpat Co-authored-by: gatsbybot Co-authored-by: Lennart --- README.md | 43 ++++++------ packages/gatsby/README.md | 140 +++++++++++++++++++++----------------- 2 files changed, 102 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index cb1bdae24a31a..04f244f00f15d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

- Gatsby v2 + Gatsby v3

@@ -36,7 +36,7 @@ PRs welcome! - Follow @gatsbyjs + Follow @GatsbyJS

@@ -52,8 +52,8 @@ Showcase · Contribute - · - Support: Twitter +
+ Support: Twitter, Discussions & Discord

@@ -78,7 +78,7 @@ Gatsby is a modern web framework for blazing fast websites. - **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 services like GitHub Pages and Netlify. + hosted entirely free on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/) and other similar services. [**Learn how to use Gatsby for your next project.**](https://www.gatsbyjs.com/docs/) @@ -88,8 +88,8 @@ Gatsby is a modern web framework for blazing fast websites. - [Learning Gatsby](#-learning-gatsby) - [Migration Guides](#-migration-guides) - [How to Contribute](#-how-to-contribute) -- [License](#memo-license) -- [Thanks to Our Contributors and Sponsors](#-thanks) +- [License](#-license) +- [Thanks to Our Contributors](#-thanks) ## 🚀 Get Up and Running in 5 Minutes @@ -107,8 +107,9 @@ You can get a new Gatsby site up and running on your local dev environment in 5 Get your Gatsby blog set up in a single command: ```shell - # create a new Gatsby site using the default starter - gatsby new my-blazing-fast-site + # Create a new Gatsby site using the interactive setup wizard + # Give it this name: My Gatsby site + gatsby new ``` 3. **Start the site in `develop` mode.** @@ -116,13 +117,13 @@ You can get a new Gatsby site up and running on your local dev environment in 5 Next, move into your new site’s directory and start it up: ```shell - cd my-blazing-fast-site/ + cd my-gatsby-site/ gatsby develop ``` 4. **Open the source code and start editing!** - Your site is now running at `http://localhost:8000`. Open the `my-blazing-fast-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes, and the browser will update in real time! + Your site is now running at `http://localhost:8000`. Open the `my-gatsby-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes, and the browser will update in real time! At this point, you’ve got a fully functional Gatsby website. For additional information on how you can customize your Gatsby site, see our [plugins](https://gatsbyjs.com/plugins/) and [the official tutorial](https://www.gatsbyjs.com/tutorial/). @@ -132,7 +133,7 @@ Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.com/). - **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. -- **To dive straight into code samples head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the “Guides”, “API Reference”, and “Advanced Tutorials” sections in the sidebar. +- **To dive straight into code samples head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the “How-to Guides”, “Reference”, and “Conceptual Guides” sections in the sidebar. We welcome suggestions for improving our docs. See the [“how to contribute”](https://www.gatsbyjs.com/contributing/how-to-contribute/) documentation for more details. @@ -140,10 +141,10 @@ We welcome suggestions for improving our docs. See the [“how to contribute”] ## 💼 Migration Guides -Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v2 to your site without starting from scratch! +Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v3 to your site without starting from scratch! -- [Migrate a Gatsby site from v1 to v2](https://www.gatsbyjs.com/docs/migrating-from-v1-to-v2/) -- Still on v0? Start here: [Migrate a Gatsby site from v0 to v1](https://www.gatsbyjs.com/docs/migrating-from-v0-to-v1/) +- [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,16 +158,18 @@ Check out our [**Contributing Guide**](https://www.gatsbyjs.com/contributing/how ### A note on how this repository is organized -This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](/packages) managed in this codebase, even though we publish them to NPM as separate packages. +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 v1 +### Contributing to Gatsby v2 -We are currently only accepting bug fixes for Gatsby v1. No new features will be accepted. +We are currently only accepting bug fixes for Gatsby v2. No new features will be accepted. -## :memo: License +## 📝 License Licensed under the [MIT License](./LICENSE). ## 💜 Thanks -Thanks to our many contributors and to [Netlify](https://www.netlify.com/) for hosting [Gatsby](https://www.gatsbyjs.com) and our example sites. +Thanks goes out to all our many contributors creating plugins, starters, videos, and blog posts. And a special appreciation for our community members helping with issues and PRs, or answering questions on Discord and GitHub Discussions. + +A big part of what makes Gatsby great is each and every one of you in the community. Your contributions enrich the Gatsby experience and make it better every day. diff --git a/packages/gatsby/README.md b/packages/gatsby/README.md index 3fed4853cb343..04f244f00f15d 100644 --- a/packages/gatsby/README.md +++ b/packages/gatsby/README.md @@ -1,59 +1,67 @@

- + Gatsby

- Gatsby v2 + Gatsby v3

- ⚛️ 📄 :rocket: + ⚛️ 📄 🚀 +

+

+ Fast in every way that matters

- Blazing fast modern site generator for React
- Go beyond static sites: build blogs, e-commerce sites, full-blown apps, and more with Gatsby. + Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps

Gatsby is released under the MIT license. - - Current TravisCI build status. + + Current CircleCI build status. - - Current npm package version. + + Current npm package version. Downloads per month on npm. + + Total downloads on npm. + PRs welcome! + + Follow @GatsbyJS +

- Quickstart - · - Tutorial + Quickstart · - Plugins + Tutorial · - Starters + Plugins · - Showcase + Starters · - Contribute + Showcase · - Support: Twitter + Contribute +
+ Support: Twitter, Discussions & Discord

-Gatsby is a modern framework for blazing fast websites. +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. - **Use a Modern Stack for Every Site.** No matter where the data comes from, Gatsby sites are @@ -65,14 +73,14 @@ Gatsby is a modern framework for blazing fast websites. to load your data, then develop using Gatsby’s uniform GraphQL interface. - **Performance Is Baked In.** Ace your performance audits by default. Gatsby automates code - splitting, image optimization, inlining critical styles, lazy-loading and prefetching resources, + 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 services like GitHub Pages and Netlify. + hosted entirely free on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/) and other similar services. -[**Learn how to use Gatsby for your next project.**](https://gatsbyjs.com/docs/) +[**Learn how to use Gatsby for your next project.**](https://www.gatsbyjs.com/docs/) ## What’s In This Document @@ -80,78 +88,88 @@ Gatsby is a modern framework for blazing fast websites. - [Learning Gatsby](#-learning-gatsby) - [Migration Guides](#-migration-guides) - [How to Contribute](#-how-to-contribute) -- [Thanks to Our Contributors and Sponsors](#-thanks-to-our-contributors-and-sponsors) +- [License](#-license) +- [Thanks to Our Contributors](#-thanks) ## 🚀 Get Up and Running in 5 Minutes -You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these three steps: +You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these four steps: + +1. **Install the Gatsby CLI.** -1. **Create a Gatsby site from a Gatsby starter.** + ```shell + npm install -g gatsby-cli - Get your Gatsby blog set up in a single command: + ``` - ```shell - # create a new Gatsby site using the default starter - gatsby new my-blazing-fast-site - ``` +2. **Create a Gatsby site from a Gatsby starter.** -2. **Start the site in `develop` mode.** + Get your Gatsby blog set up in a single command: - Next, move into your new site’s directory and start it up: + ```shell + # Create a new Gatsby site using the interactive setup wizard + # Give it this name: My Gatsby site + gatsby new + ``` - ```shell - cd my-blazing-fast-site/ - npm run develop - ``` +3. **Start the site in `develop` mode.** -3. **Open the source code and start editing!** + Next, move into your new site’s directory and start it up: - Your site is now running at `http://localhost:8000`. Open the `my-blazing-fast-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time! + ```shell + cd my-gatsby-site/ + gatsby develop + ``` -At this point, you’ve got a fully functional Gatsby website. For additional information on how you can customize your Gatsby site, see our [plugins](https://gatsbyjs.com/plugins/) and [the official tutorial](https://gatsbyjs.com/tutorial/). +4. **Open the source code and start editing!** + + Your site is now running at `http://localhost:8000`. Open the `my-gatsby-site` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes, and the browser will update in real time! + +At this point, you’ve got a fully functional Gatsby website. For additional information on how you can customize your Gatsby site, see our [plugins](https://gatsbyjs.com/plugins/) and [the official tutorial](https://www.gatsbyjs.com/tutorial/). ## 🎓 Learning Gatsby -Full documentation for Gatsby lives [on the website](https://gatsbyjs.com/). +Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.com/). -- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://gatsbyjs.com/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. +- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. -- **To dive straight into code samples head [to our documentation](https://gatsbyjs.com/docs/).** In particular, check out the “Guides”, API reference, and “Advanced Tutorials” sections in the sidebar. +- **To dive straight into code samples head [to our documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the “How-to Guides”, “Reference”, and “Conceptual Guides” sections in the sidebar. -We welcome suggestions for improving our docs. See the [“how to contribute”](https://gatsbyjs.com/contributing/how-to-contribute/) documentation for more details. +We welcome suggestions for improving our docs. See the [“how to contribute”](https://www.gatsbyjs.com/contributing/how-to-contribute/) documentation for more details. -**Start Learning Gatsby: [Follow the Tutorial](https://gatsbyjs.com/tutorial/) · [Read the Docs](https://gatsbyjs.com/docs/)** +**Start Learning Gatsby: [Follow the Tutorial](https://www.gatsbyjs.com/tutorial/) · [Read the Docs](https://www.gatsbyjs.com/docs/)** ## 💼 Migration Guides -Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v2 to your site without starting from scratch! +Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v3 to your site without starting from scratch! + +- [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 -- [Migrate a Gatsby site from v1 to v2](https://gatsbyjs.com/docs/migrating-from-v1-to-v2/) -- Still on v0? Start here: [Migrate a Gatsby site from v0 to v1](https://gatsbyjs.com/docs/migrating-from-v0-to-v1/) +Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our [**Code of Conduct**](https://www.gatsbyjs.com/contributing/code-of-conduct/). Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜 ## 🤝 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: -Check out our [contributor onboarding docs](https://gatsbyjs.com/contributing/how-to-contribute/) for ideas on contributing and setup steps for getting our repos up and running on your local machine. +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. -[**Read the Contributing Guide**](https://gatsbyjs.com/contributing/how-to-contribute/) - -### Code of Conduct +### A note on how this repository is organized -Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our [Code of Conduct](https://gatsbyjs.com/contributing/code-of-conduct/). Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜 +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. -[**Read the Code of Conduct**](https://gatsbyjs.com/contributing/code-of-conduct/) +### Contributing to Gatsby v2 -### A note on how this repository is organized +We are currently only accepting bug fixes for Gatsby v2. No new features will be accepted. -This repository is a [monorepo](https://trunkbaseddevelopment.com/monorepos/) managed using [Lerna](https://github.com/lerna/lerna). This means there are [multiple packages](/plugins) managed in this codebase, even though we publish them to NPM as separate packages. +## 📝 License -### Contributing to Gatsby v1 +Licensed under the [MIT License](./LICENSE). -We are currently only accepting bug fixes for Gatsby v1. No new features will be accepted. +## 💜 Thanks -## 💜 Thanks to Our Contributors and Sponsors +Thanks goes out to all our many contributors creating plugins, starters, videos, and blog posts. And a special appreciation for our community members helping with issues and PRs, or answering questions on Discord and GitHub Discussions. -Thanks to our many contributors and sponsors as well as the companies sponsoring -our testing and hosting infrastructure: [Travis CI](https://travis-ci.com/), [Appveyor](https://www.appveyor.com/), and [Netlify](https://www.netlify.com/). +A big part of what makes Gatsby great is each and every one of you in the community. Your contributions enrich the Gatsby experience and make it better every day.