Skip to content

Commit 5ad9582

Browse files
authoredJul 2, 2020
Remove unnecessary overview from frontmatter (#25288)
1 parent 51d28bb commit 5ad9582

26 files changed

+0
-26
lines changed
 

‎docs/docs/ab-testing.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: A/B Testing
3-
overview: true
43
---
54

65
A/B or split testing is when you make test changes to a website. Suppose you have two buttons: a green “Buy Now!” button and a red “Buy Now!” button. You want to figure out which button will receive the most clicks. An A/B test would be an ideal way to measure engagement.

‎docs/docs/adding-app-and-website-functionality.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Adding App and Website Functionality
3-
overview: true
43
---
54

65
Gatsby empowers developers and creators to make many different types of websites. One may wish to add additional functionality to their site such as search, authentication, forms, comments, and plenty of others.

‎docs/docs/adding-page-transitions.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Adding Page Transitions
3-
overview: true
43
---
54

65
Page transitions give users a better experience when navigating between pages. There are a number of ways to add them to your Gatsby site.

‎docs/docs/adding-search.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Adding Search
3-
overview: true
43
---
54

65
See below for a list of guides in this section, or keep reading for an overview on adding search functionality to your site.

‎docs/docs/api-reference.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Gatsby API Reference
3-
overview: true
43
---
54

65
Learn more about Gatsby API methods and options, common files, and customizations.

‎docs/docs/conceptual-guide.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Conceptual Guide
3-
overview: true
43
---
54

65
Read high-level overviews of important Gatsby concepts and philosophies.

‎docs/docs/css-in-js.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Enhancing Styles with CSS-in-JS
3-
overview: true
43
---
54

65
CSS-in-JS refers to an approach where styles are written in JavaScript instead of in external CSS files to easily scope styles in components, eliminate dead code, encourage faster performance and dynamic styling, and more.

‎docs/docs/css-libraries-and-frameworks.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: CSS Libraries and Frameworks
3-
overview: true
43
---
54

65
There are many other CSS style libraries and frameworks that you can use in your Gatsby project.

‎docs/docs/customization.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Custom Configuration
3-
overview: true
43
---
54

65
Sometimes you may find yourself in a situation where Gatsby's default configuration just isn't quite what you need for your site. If you should find yourself in this situation, have no fear my friend, you can customize Gatsby's config for `babel` and `webpack`. You can also customize `html.js`, the React component used to generate the initial HTML file of your build. You'll also find guides on how to get custom environment variables into your website, as well how to proxy API requests in development so your API calls aren't interpreted by your server as static assets.

‎docs/docs/debugging.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Debugging
3-
overview: true
43
---
54

65
While building your site, you’ll sometimes encounter bugs. These guides help you set up debugging in Gatsby so you can spot and squash bugs more easily.

‎docs/docs/deploying-and-hosting.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Deploying and Hosting
3-
overview: true
43
---
54

65
Getting your shiny new Gatsby site deployed and accessible is probably the first thing you will want to do now that it's built! Also, give yourself a pat on the back real quick for creating something so great!

‎docs/docs/graphql.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: GraphQL & Gatsby
3-
overview: true
43
---
54

65
When building with Gatsby, you access your data through a query language named [GraphQL](https://graphql.org/). GraphQL allows you to declaratively express your data needs. This is done with `queries`, queries are the representation of the data you need. A query looks like this:

‎docs/docs/guides.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Reference Guides
3-
overview: true
43
---
54

65
Dive deeper into different topics around building with Gatsby, like sourcing data, building and styling pages, deployment, and more. While the [tutorials](/tutorial/) are step-by-step instructions, reference guides are resources about the various Gatsby development techniques.

‎docs/docs/headless-cms.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: What is a Headless CMS and How to Source Content from One
3-
overview: true
43
---
54

65
A _headless CMS_ is content management software that enables writers to produce and organize content, while providing developers with structured data that can be displayed using a separate system on the frontend of a website or app.

‎docs/docs/partnering-with-gatsby.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Partnering with Gatsby
3-
overview: true
43
---
54

65
If you're an organization in the website space -- whether a vendor or an agency -- we'd love to work together with you.

‎docs/docs/performance.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Performance
3-
overview: true
43
---
54

65
While performance is already at the heart of Gatsby, it's important to ensure you are doing all you can to make your content available to your users as fast as possible. Not all users are enjoying high speed connections, or browsing from a desktop. It's important to make no assumptions and serve the smallest and fastest site possible, to provide an optimal experience for wherever your users might be coming from. Since Gatsby is already doing a lot of the heavy lifting for you there isn't a lot required out of the box to make your site blazing fast, but by following these guides you can ensure the best possible performance and delivery of your content to your users.

‎docs/docs/plugins-themes-and-starters.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Plugins, Themes, & Starters
3-
overview: true
43
---
54

65
In the Gatsby ecosystem, there's more than one way to build a site. To help you understand the differences between plugins, themes, and starters, this guide will talk through some of the details.

‎docs/docs/preparing-for-site-launch.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Preparing Your Site for Launch
3-
overview: true
43
---
54

65
So your Gatsby site is done, and you're ready to share it with the world, **congratulations**! 🎉

‎docs/docs/preparing-your-environment.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Preparing Your Environment
3-
overview: true
43
---
54

65
To get started with Gatsby, you'll need to make sure you have the following software tools installed:

‎docs/docs/releases-and-migration.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Releases & Migration
3-
overview: true
43
---
54

65
Find release notes and guides on how to upgrade Gatsby along with third-party packages.

‎docs/docs/styling.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Styling
3-
overview: true
43
---
54

65
There are many ways to style your website. They can roughly be grouped into three styling approaches:

‎docs/docs/testing.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Adding Testing
3-
overview: true
43
disableTableOfContents: true
54
---
65

‎docs/docs/themes.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Themes
3-
overview: true
43
disableTableOfContents: true
54
---
65

‎docs/docs/using-gatsby-professionally.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Using Gatsby Professionally
3-
overview: true
43
---
54

65
As a Gatsby developer and enthusiast, you may be interested in how you can spend more of your time professionally building with Gatsby.

‎www/src/templates/template-docs-markdown.js

-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ export const pageQuery = graphql`
4141
frontmatter {
4242
title
4343
description
44-
overview
4544
issue
4645
disableTableOfContents
4746
tableOfContentsDepth

‎www/src/utils/node/docs.js

-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ exports.createSchemaCustomization = ({ actions: { createTypes } }) => {
4949
showTopLevelSignatures: Boolean
5050
disableTableOfContents: Boolean
5151
tableOfContentsDepth: Int
52-
overview: Boolean
5352
issue: String
5453
jsdoc: [String!]
5554
apiCalls: String

0 commit comments

Comments
 (0)
Please sign in to comment.