Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Update title casing #18375

Merged
merged 6 commits into from
Oct 14, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/add-404-page.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Adding a 404 Page"
title: Adding a 404 Page
---

To create a 404 page create a page whose path matches the regex
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/add-a-manifest-file.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Add a Manifest File
title: Adding a Manifest File
---

If you've run an [audit with Lighthouse](/docs/audit-with-lighthouse/), you may have noticed a lackluster score in the "Progressive Web App" category. Let's address how you can improve that score.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/add-a-service-worker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Add a Service Worker
title: Adding a Service Worker
---

## What is a service worker
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/add-custom-webpack-config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Adding a Custom webpack Config"
title: Adding a Custom webpack Config
---

_Before creating custom webpack configuration, check to see if there's a Gatsby
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/add-offline-support-with-a-service-worker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Add Offline Support with a Service Worker
title: Adding Offline Support with a Service Worker
---

If you've run an [audit with Lighthouse](/docs/audit-with-lighthouse/), you may have noticed a lackluster score in the "Progressive Web App" category. Let's address how you can improve that score.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/add-page-metadata.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding page metadata
title: Adding Page Metadata
---

If you've run an [audit with Lighthouse](/docs/audit-with-lighthouse/), you may have noticed a lackluster score in the "SEO" category. Let's address how you can improve that score.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/add-seo-component.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Adding an SEO component"
title: Adding an SEO Component
---

Every site on the web has basic _meta-tags_ like the title, favicon or description of the page in their `<head>` element. This information gets displayed in the browser and is used when someone shares your website, e.g. on Twitter. You can give your users and these websites additional data to embed your website with more data — and that's where this guide for a SEO component comes in. At the end you'll have a component you can place in your layout file and have rich previews for other clients, smartphone users, and search engines.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-analytics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding analytics
title: Adding Analytics
---

## Why use analytics?
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-forms.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding forms
title: Adding Forms
---

Gatsby is built on top of React. So anything that is possible with a React form is possible in Gatsby. Additional details about how to create React forms can be found in the [React forms documentation](https://reactjs.org/docs/forms.html) (which happens to be built with Gatsby!)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-pagination.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding pagination
title: Adding Pagination
---

A page displaying a list of content gets longer as the amount of content grows.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-search-with-algolia.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding search with Algolia
title: Adding Search with Algolia
---

Once you've added some content to your site, you'll want to make it easy for your visitors to find what they're looking for. This guide will run you through the process of setting up a custom search experience powered by [Algolia](https://www.algolia.com) on any Gatsby site. You'll be writing functional components that rely on React Hooks so following this guide requires you to be using [React 16.8](https://reactjs.org/blog/2019/02/06/react-v16.8.0) or higher.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-search-with-elasticlunr.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding search with elasticlunr
title: Adding Search with Elasticlunr
---

This is a stub. Help our community expand it.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-search-with-js-search.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding search with js-search
title: Adding Search with JS Search
---

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-search.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Adding search"
title: Adding Search
overview: true
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/adding-website-functionality.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adding website functionality
title: Adding Website Functionality
overview: true
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-proxy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Proxying API Requests in Development"
title: Proxying API Requests in Development
---

## Resources
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/awesome-gatsby-resources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Awesome Gatsby Resources"
title: Awesome Gatsby Resources
---

A curated list of interesting Gatsby community projects and learning resources.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/building-apps-with-gatsby.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Building Apps with Gatsby"
title: Building Apps with Gatsby
---

Gatsby is an excellent framework for building web apps. You can use Gatsby to create personalized, logged-in experiences with two different approaches.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/caching.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Caching Static Sites"
title: Caching Static Sites
---

An important part of creating a very fast website is setting up proper HTTP caching. HTTP caching allows browsers to cache resources from a website so that when the user returns to a site, very few parts of the website have to be downloaded.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/client-only-routes-and-user-authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Client-Only Routes & User Authentication"
title: Client-only Routes & User Authentication
---

Often you want to create a site with client-only portions that are gated by authentication.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/coming-from-react-to-gatsby.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Coming from React to Gatsby: What You Need to Know"
title: Coming from React to Gatsby: What You Need to Know
---

This is a stub. Help our community expand it.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/creating-a-source-plugin.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Creating a Source Plugin"
title: Creating a Source Plugin
---

There are two types of plugins that work within Gatsby's data system: "source"
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/creating-and-modifying-pages.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Creating and Modifying Pages"
title: Creating and Modifying Pages
---

Gatsby makes it easy to programmatically control your pages.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/creating-global-styles.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Creating global styles
title: Creating Global Styles
---

Creating global styles for your Gatsby site depends on your styling approach, so we've moved the instructions to the relevant guides:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/debugging-the-build-process.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Debugging the build process
title: Debugging the Build Process
---

Gatsby's `build` and `develop` steps run as a Node.js application which you can debug using standard tools for Node.js applications.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Environment Variables"
title: Environment Variables
---

## Environments and Environment Variables
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/first-professional-project.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "First Professional Project"
title: First Professional Project
---

The most important professional Gatsby project you or your organization will ever ship is your first project.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/gatsby-in-the-enterprise.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Building With Gatsby in the Enterprise"
title: Building With Gatsby in the Enterprise
---

Some Gatsby advocates may be working inside “enterprise” software development organizations. Others may work at agencies which work closely with such organizations.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/gatsby-source-filesystem-programmatic-import.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: gatsby-source-filesystem programmatic import
title: gatsby-source-filesystem Programmatic Import
issue: https://github.com/gatsbyjs/gatsby/issues/9018
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/headless-cms.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: What is a Headless CMS and how to source content from one
title: What is a Headless CMS and How to Source Content from One
overview: true
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/importing-assets-into-files.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Importing Assets Directly Into Files"
title: Importing Assets Directly Into Files
---

There are two major ways to import assets, such as images, fonts, and files, into a Gatsby site. The default path is to import the file directly into a Gatsby template, page, or component. The alternative path, which makes sense for some edge cases, is to use the [static folder](/docs/static-folder).
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/interactive-pages.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Interactive pages
title: Interactive Pages
---

This is a stub. Help our community expand it.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/linking-and-prefetching-with-gatsby.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Linking and prefetching with Gatsby
title: Linking and Prefetching with Gatsby
---

This is a stub. Help our community expand it.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/linking-between-pages.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Linking between pages
title: Linking Between Pages
---

This guide covers how to link between pages in a Gatsby site.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/local-https.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Local HTTPS"
title: Local HTTPS
---

Gatsby provides an easy way to use a local HTTPS server during development, thanks to [devcert](https://github.com/davewasmer/devcert). When you enable the `https` option, a private key and certificate file will be created for your project and used by the development server.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/location-data-from-props.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Location Data from Props"
title: Location Data from Props
---

## What is location data
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/page-query.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Querying data in pages with GraphQL
title: Querying Data in Pages with GraphQL
---

Gatsby's `graphql` tag enables page components to retrieve data via a GraphQL query.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/performance-tracing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Performance tracing"
title: "Performance Tracing"
---

Gatsby allows a build to be traced, enabling you to find which plugins or parts of the build are taking the longest. The trace information can be viewed in any [OpenTracing](http://opentracing.io/) compatible tool such as [Jaeger](https://www.jaegertracing.io/). You can also use Zipkin compatible tools such as [Zipkin](https://zipkin.io/) or [Honeycomb](https://www.honeycomb.io/).
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/preoptimizing-images.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Preoptimizing your Images
title: Preoptimizing Your Images
---

Gatsby ships with excellent image optimization capabilities (see the [Image Tutorial](/tutorial/image-tutorial/) for more info). However, this image optimization can come with a cost. It can be fairly CPU intensive, and in some cases may lead to long build times. As a means of debugging and perhaps improving your overall build performance, it _may_ be helpful to pre-optimize your (extremely large) images.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/progressive-web-app.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Progressive web apps (PWAs)
title: Progressive Web Apps (PWAs)
---

## What is a progressive web app?
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Quick Start"
title: Quick Start
---

This quick start is intended for intermediate to advanced developers. For a gentler intro to Gatsby, [head to our tutorial](/tutorial/)!
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reach-router-and-gatsby.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "@reach/router and Gatsby"
title: @reach/router and Gatsby
---

This is a stub. Help our community expand it.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/releases-and-migration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Releases & Migration"
title: Releases & Migration
overview: true
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/remark-plugin-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Remark Plugin Tutorial"
title: Remark Plugin Tutorial
---

[`gatsby-transformer-remark`](/packages/gatsby-transformer-remark) empowers developers to translate Markdown into HTML to be consumed via Gatsby's GraphQL API. Blogs and other content based sites can highly benefit from functionality enabled with this plugin. With this plugin, authors of content for the site don't need to worry about how the site is written or structured but can rather focus on writing engaging posts and content!
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/rendering-sidebar-navigation-dynamically.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Rendering sidebar navigation dynamically
title: Rendering Sidebar Navigation Dynamically
issue: https://github.com/gatsbyjs/gatsby/issues/9779
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/schema-connections.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Schema connections
title: Schema Connections
---

> This documentation isn't up to date with the latest [schema customization changes](/docs/schema-customization).
Expand Down
4 changes: 3 additions & 1 deletion docs/docs/schema-customization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Customizing the GraphQL Schema
---
title: Schema Customization
---

One of Gatsby's main strengths is the ability to query data from a variety of
sources in a uniform way with GraphQL. For this to work, a GraphQL Schema must
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/starters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Gatsby Starters"
title: Gatsby Starters
---

The Gatsby CLI tool lets you install **starters**, which are boilerplate Gatsby sites maintained by the community and intended for jump-starting development quickly.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/testing-components-with-graphql.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Testing components with GraphQL
title: Testing Components with GraphQL
---

If you try to run unit tests on components that use GraphQL queries, you will
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/testing-css-in-js.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Testing CSS-in-JS"
title: Testing CSS-in-JS
---

Popular CSS-in-JS libraries like [styled-components](https://github.com/styled-components/styled-components) or [emotion](https://github.com/emotion-js/emotion) can also be tested with the help of [jest-styled-components](https://github.com/styled-components/jest-styled-components) or [jest-emotion](https://github.com/emotion-js/emotion/tree/master/packages/jest-emotion) respectively. These packages improve Jest's built-in snapshot testing experience and are a great way to help avoid unintended changes to your website's UI. Please refer to your package's documentation to see if it also offers testing capabilities.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/testing-react-components.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Testing React components"
title: Testing React Components
---

_The recommended testing framework is [Jest](https://jestjs.io/). This guide assumes that you followed the [Unit testing](/docs/unit-testing) guide to setup Jest._
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/third-party-graphql.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Using third-party GraphQL APIs"
title: Using Third-party GraphQL APIs
---

Gatsby v2 introduces a simple way to integrate any GraphQL API into Gatsby's GraphQL. You can integrate both third-party APIs, like GitHub's, APIs of services like GraphCMS or your custom GraphQL API.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/what-is-a-plugin.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "What is a Plugin?"
title: What is a Plugin?
---

Gatsby plugins are Node.js packages that implement Gatsby APIs. For larger, more complex sites, plugins let you modularize your site customizations into site-specific plugins.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/winning-over-marketers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Winning Over Marketers"
title: Winning Over Marketers
---

Some things that marketers care about include:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/winning-over-stakeholders.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Winning Over Stakeholders"
title: Winning Over Stakeholders
---

Any website project has multiple stakeholders, such as developers, marketers, content creators, engineering leaders, executives, and clients.
Expand Down