diff --git a/docs/docs/glossary.md b/docs/docs/glossary.md index 8d326a8359df2..3f5f6321443ea 100644 --- a/docs/docs/glossary.md +++ b/docs/docs/glossary.md @@ -186,6 +186,10 @@ Once a site has been [built](#build) by Gatsby and loaded in a web browser, [cli As part of its data layer and [build](#build) process, Gatsby will automatically **infer** a [schema](#schema), or type-based structure, based on available data sources (e.g. Markdown file nodes, WordPress posts, etc.). More control can be gained over this structure by using Gatsby's [Schema Customization API](/docs/schema-customization/). +### [Infrastructure As Code](/docs/glossary/infrastructure-as-code/) + +Infrastructure As Code is the practice of using configuration files and scripts to automate the process of setting up your development, testing, and production environments. + ## J ### [JAMStack](/docs/glossary/jamstack) diff --git a/docs/docs/glossary/infrastructure-as-code/index.md b/docs/docs/glossary/infrastructure-as-code/index.md new file mode 100644 index 0000000000000..66adcbac5d26b --- /dev/null +++ b/docs/docs/glossary/infrastructure-as-code/index.md @@ -0,0 +1,84 @@ +--- +title: Infrastructure as Code +disableTableOfContents: true +--- + +Learn what Infrastructure as Code means, and how you can use code to standardize and automate your Gatsby site. + +## What is Infrastructure as Code? + +_Infrastructure as Code_, or IaC, is the practice of managing your development, testing, and production environments using configuration files or scripts. Provisioning and configuring environments individually can introduce errors or inconsistencies. You may, for example, find yourself running different versions of Node on your laptop and your production servers. Infrastructure as Code minimizes this kind of drift and lets you automate the process of provisioning environments. + +Your configuration file describes what resources your project requires. If you're building an API, for example, you might create a configuration file that says, "Please install Node 12.16.2, npm 6.14.4, Express 4.17.1, and PostgreSQL 12.2 for Ubuntu Linux." For a Gatsby project, your configuration file may add plugins and themes. + +Configuration files, like other code files, are text. That means you can use version control software to store them and track changes to the environment. In short, IaC: + +- Creates consistent environments. +- Saves time that would otherwise be spent setting up environments. +- Reduces the risk of errors caused by mismatched environments. +- Lays the groundwork for automation. + +## Automating Gatsby site development with Gatsby Recipes + +[Gatsby Recipes](/blog/2020-04-15-announcing-gatsby-recipes/) applies the infrastructure as code concept to front-end development. With Gatsby Recipes, you can automate common site building tasks, such as adding a plugin or test suite. + +To get started with Gatsby Recipes, upgrade to the latest version of Gatsby and the Gatsby CLI. + +```shell +npm install -g gatsby-cli@latest +npm install gatsby@latest +``` + +You can see the list of available recipes by using `gatsby recipes`. Use your up or down arrow keys to select a recipe, and press the _Enter_ or _Return_ key to run it. + +![partial list of available Gatsby recipes](recipes-screenshot.png) + +Gatsby Recipes use [MDX](/docs/glossary/mdx/). They're a readable mix of Markdown and React. MDX is an extension of [Markdown](/docs/glossary/markdown/) that lets you use [JSX](/docs/glossary#jsx) in Markdown-formatted documents. As an example, check out the [Styled Components recipe](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-recipes/recipes/styled-components.mdx). + +```markdown +# Setup Styled Components + +[Styled Components](https://styled-components.com/) is visual primitives for the component age. +Use the best bits of ES6 and CSS to style your apps without stress 💅 + +--- + +Install necessary NPM packages + + + + + +--- + +Install the Styled Components plugin in gatsby-config.js + + + +--- + +Sweet, now it's ready to go. + +Let's also write out an example page you can use to play +with Styled Components. + + + +--- + +Read more about Styled Components on the official docs site: + +https://styled-components.com/ +``` + +You can also write and run your own recipes, or run recipes that were created by and shared with the community. Pass the path or URL of the recipe as an argument. For example, to run a local Gatsby recipe, use `gatsby recipes ./name-of-your-recipe.mdx`. To run a remote recipe, use `gatsby recipes https://example.com/community-made-recipe.mdx`. + +Gatsby Recipes help you save time and reduce configuration errors by automating the set up process. + +## Learn more + +- [Announcing Gatsby Recipes](/blog/2020-04-15-announcing-gatsby-recipes/) +- [Developing Recipes](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-recipes/README.md#developing-recipes) from the Gatsby repository diff --git a/docs/docs/glossary/infrastructure-as-code/recipes-screenshot.png b/docs/docs/glossary/infrastructure-as-code/recipes-screenshot.png new file mode 100644 index 0000000000000..f793151c4a63e Binary files /dev/null and b/docs/docs/glossary/infrastructure-as-code/recipes-screenshot.png differ diff --git a/www/src/data/sidebars/doc-links.yaml b/www/src/data/sidebars/doc-links.yaml index c1ed1a0ff9d4a..80ce142c8bb0a 100644 --- a/www/src/data/sidebars/doc-links.yaml +++ b/www/src/data/sidebars/doc-links.yaml @@ -778,6 +778,8 @@ link: /docs/glossary/hydration/ - title: JAMStack link: /docs/glossary/jamstack/ + - title: Infrastructure as Code + link: /docs/glossary/infrastructure-as-code/ - title: Markdown link: /docs/glossary/markdown/ - title: MDX