Glossary, encyclopedia: Add Infrastructure As Code article. #23431
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated glossary.md with a definition/excerpt and link to new entry. Also updated doc-links.yaml with link to new entry.
|
@AishaBlake @hashimwarren I'm not sure whether hit the mark with this one. |
AishaBlake
suggested changes
Apr 30, 2020
There was a problem hiding this comment.
Thanks for this, @webinista! I have a few comments. @hashimwarren I feel like this is as complete as it needs to be but I'll defer to you in case there's anything else you were hoping to hit on from a Marketing perspective.
| @@ -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/) | |||
There was a problem hiding this comment.
Suggested change
| ### [Infrastructure As Code](/docs/glossary/infrastructure-as-code/) | |
| ### [Infrastructure as Code](/docs/glossary/infrastructure-as-code/) |
I think we can refer to this as Infrastructure as Code or IaC throughout. As long as "as" isn't capitalized and we're consistent all the way through, I'm good.
| disableTableOfContents: true | ||
| --- | ||
|
|
||
| Learn what <q>Infrastructure as Code</q> means, and how you can use can use code to standardize and automate your Gatsby site. |
There was a problem hiding this comment.
Suggested change
| Learn what <q>Infrastructure as Code</q> means, and how you can use can use code to standardize and automate your Gatsby site. | |
| Learn what <q>Infrastructure as Code</q> means, and how you can use code to standardize and automate your Gatsby site. |
| - Creates consistent environments. | ||
| - Saves time that would otherwise be spent setting up environments. | ||
| - Reduces the risk of errors caused by mismatched environments. | ||
| - Makes it easy to automate tasks. |
There was a problem hiding this comment.
Rather than "easy" maybe a more polished version of "sets you up to automate tasks"?
There was a problem hiding this comment.
Would "simplifies the automation of tasks" or "simplifies task automation" work?
There was a problem hiding this comment.
Went with "Lays the groundwork for..."
|
|
||
| ## What is <q>Infrastructure As Code?</q> | ||
|
|
||
| _Infrastructure As Code_ 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 mimimizes this kind of drift and lets you automate the process of provisioning environments. |
There was a problem hiding this comment.
Suggested change
| _Infrastructure As Code_ 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 mimimizes this kind of drift and lets you automate the process of provisioning environments. | |
| _Infrastructure As Code_ 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. |
|
|
||
| ## Automating Gatsby site development with Gatsby Recipes | ||
|
|
||
| [Gatsby Recipes](https://www.gatsbyjs.org/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. |
There was a problem hiding this comment.
Suggested change
| [Gatsby Recipes](https://www.gatsbyjs.org/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. | |
| [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. |
|
|
||
| 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. | ||
|
|
||
|  |
There was a problem hiding this comment.
I would make infrastructure-as-code a folder and copy this image into it. This file would then be index.md in the same folder.
|
|
||
|  | ||
|
|
||
| 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. Here's the [Styled Components](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-recipes/recipes/styled-components.mdx) recipe. |
There was a problem hiding this comment.
Suggested change
| 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. Here's the [Styled Components](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-recipes/recipes/styled-components.mdx) recipe. | |
| 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). |
Also switch to relative internal links.
Add recipes-screenshot.png
|
For my purposes, this article nails it @AishaBlake |
AishaBlake
previously approved these changes
May 5, 2020
There was a problem hiding this comment.
I shortened the alt text but I'm happy with these changes! Thanks, @webinista!
AishaBlake
approved these changes
May 5, 2020
This was referenced May 26, 2020
|
i feel there is too much about Recipes in this part in a guide-style - i opened a discussion here:
|
This was referenced Sep 1, 2021
This was referenced Jan 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated glossary.md with a definition/excerpt and link to new entry.
Also updated doc-links.yaml with link to new entry.