Skip to content

Commit e9f2a6f

Browse files
lundgren2pieh
authored andcommitted
fix(docs): update broken links with working links (#9912)
<!-- Q. Which branch should I use for my pull request? A. Use `master` branch (probably). Q. Which branch if my change is a bug fix for Gatsby v1? A. In this case, you should use the `v1` branch Q. Which branch if I'm still not sure? A. Use `master` branch. Ask in the PR if you're not sure and a Gatsby maintainer will be happy to help :) Note: We will only accept bug fixes for Gatsby v1. New features should be added to Gatsby v2. Learn more about contributing: https://www.gatsbyjs.org/docs/how-to-contribute/ -->
1 parent 766ea4c commit e9f2a6f

File tree

20 files changed

+37
-39
lines changed

20 files changed

+37
-39
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<a href="https://npmcharts.com/compare/gatsby?minimal=true">
2828
<img src="https://img.shields.io/npm/dm/gatsby.svg" alt="Downloads per month on npm." />
2929
</a>
30-
<a href="https://gatsbyjs.org/docs/how-to-submit-a-pr/">
30+
<a href="https://gatsbyjs.org/docs/how-to-contribute">
3131
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
3232
</a>
3333
</p>

docs/blog/2018-01-22-getting-started-gatsby-and-wordpress/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,4 +140,4 @@ While this isn't a tutorial -- more a guided walkthrough of me familiarizing and
140140
2. Gatsby makes heavy use of [plugins](/docs/plugins/) — both official and community — for a lot of things, from one that implements [Google Analytics](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-google-analytics), to one that adds [GitHub's accessibility error scanner](https://github.com/alampros/gatsby-plugin-accessibilityjs) to all pages.
141141
3. Read through some of the source code. I particularly enjoyed reading through [the bootstrap process](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/src/bootstrap/index.js). (It's beautifully commented).
142142
4. Gatsby.js is a static Progressive Web App (PWA) generator, but to be PWA friendly (at least according to the [Lighthouse PWA audit](https://developers.google.com/web/tools/lighthouse/)), look into two plugins: `gatsby-plugin-manifest` and `gatsby-plugin-offline`.
143-
5. I did end up [deploying with Netlify](/docs/deploy-gatsby/#netlify), and I'm super happy with it. (A [previous post](/blog/2017-12-06-gatsby-plus-contentful-plus-netlify/#solution-netlify--gatsby) discussed Netlify a bit more, if you're interested).
143+
5. I did end up [deploying with Netlify](/docs/deploying-to-netlify), and I'm super happy with it. (A [previous post](/blog/2017-12-06-gatsby-plus-contentful-plus-netlify/#solution-netlify--gatsby) discussed Netlify a bit more, if you're interested).

docs/blog/2018-02-16-bright-future-for-the-web/index.md

-2
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,3 @@ The final piece of the puzzle was determining where to host the website. I had r
3535
After a little over a month of tinkering on the design during nights and weekends I had a fully functional website ready to be launched. During this process I learned a fair bit of how to code with React and the Gatsby community seemed genuinely nice and happy to help me to learn. The final product was a website that felt like it belonged in 2018 while still allowing my wife to easily update content with no assistance. Not only that the website was immensely faster than the previous WordPress version, served over HTTPS, utilized a CDN and cost me $0 dollars a month thanks to the extremely generous free tiers offered by Netlify and Contentful. 😍
3636

3737
If you are currently on the fence about static site generators or the JAMstack in general there has never been a better time to jump in. In my humble opinion with these tools it has finally reached the level of maturity to not just be feasible for client work but actually pretty darn amazing.
38-
39-
For those interested the source code for the website I built is available on GitHub: https://github.com/ryanwiemer/knw

docs/blog/2018-06-14-escalade-sports-from-5000-to-5-in-hosting/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Working with another developer, a photographer, and a graphic designer, he found
4242

4343
“Almost all the code we used in prototyping went into production,” says Rose. “Especially back in the Drupal days, that was just not going to happen.
4444

45-
Another unexpected benefit was the cost reduction of hosting static content, instead of running PHP servers. After migrating to Gatsby, Rose moved the cajunbowfishing.com website hosting over to [Netlify](www.netlify.com).
45+
Another unexpected benefit was the cost reduction of hosting static content, instead of running PHP servers. After migrating to Gatsby, Rose moved the cajunbowfishing.com website hosting over to [Netlify](https://www.netlify.com).
4646

4747
“Our bill went from $5,000 a month to $5,” he says.
4848

docs/blog/2018-06-18-moving-from-create-react-app-to-gatsby-js/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ I will not go in depth with how to manage state with React since there are a lot
265265

266266
![server-2160321 1280](https://images.ctfassets.net/4x6byznv2pet/2xjoMXpIKoAwAM4sqeOCcA/721945e76b4b5861476a9ce8781a326c/server-2160321_1280.jpg)
267267

268-
Since Gatsby builds "static" files you can host them on tons of services. One of my favourites is [Netlify](https://www.netlify.com/). There is also [AWS S3](https://aws.amazon.com/s3/) and more, see the [deploying Gatsby documentation](/docs/deploy-gatsby/) for examples.
268+
Since Gatsby builds "static" files you can host them on tons of services. One of my favourites is [Netlify](https://www.netlify.com/). There is also [AWS S3](https://aws.amazon.com/s3/) and more, see the [deploying Gatsby documentation](/docs/deploying-and-hosting/) for examples.
269269

270270
## Resources
271271

docs/blog/2018-07-07-the-gatsby-plugin-page-creator/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here's how it all got started. The goal with [Gatsby Manor](https://gatsbymanor.
1919
is to create professional designed Gatsby starters
2020
to give your site a clean, modern look the moment you create a new project.
2121
While creating our newest starter
22-
[gatsby-starter-eventually](https://gatsbymanor.com/demo/eventually),
22+
[gatsby-starter-eventually](https://github.com/gatsbymanor/gatsby-starter-eventually),
2323
I wanted to organize the directory structure of the project to better fit my
2424
workflow.
2525

docs/blog/2018-08-09-swag-store/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,6 @@ Thanks for being part of the open source community! 💪💜
7676
[shopify]: https://www.shopify.com/
7777
[js-buy-sdk]: https://shopify.github.io/js-buy-sdk/
7878
[auth0]: https://auth0.com/
79-
[invite]: https://github.com/gatsbyjs/peril-gatsbyjs/blob/master/org/invite-collaborator.ts
79+
[invite]: https://github.com/gatsbyjs/peril-gatsbyjs/blob/master/rules/invite-collaborator.ts
8080
[peril]: https://github.com/danger/peril
8181
[contribute]: /docs/how-to-contribute/

docs/blog/2018-1-18-strapi-and-gatsby/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ Since the content is managed by Strapi, the authors can write article through a
596596

597597
Feel free to continue this project to discover both Gatsby and Strapi advantages. Here are some features you can add: list of authors, article's categories, and comment system with the Strapi API or Disqus. You can also create other kind of websites (e-commerce shop, corporate website, etc.).
598598

599-
When your project is achieved, you will probably want to deploy it. The static website generated by Gatsby can [easily be published on storage providers](https://www.gatsbyjs.org/docs/deploy-gatsby/): Netlify, S3/Cloudfront, GitHub pages, GitLab pages, Heroku, etc. The Strapi API is nothing else than a simple Node.js API, so it can be hosted on Heroku or any Linux instance that has Node.js installed.
599+
When your project is achieved, you will probably want to deploy it. The static website generated by Gatsby can [easily be published on storage providers](https://www.gatsbyjs.org/docs/deploying-and-hosting): Netlify, S3/Cloudfront, GitHub pages, GitLab pages, Heroku, etc. The Strapi API is nothing else than a simple Node.js API, so it can be hosted on Heroku or any Linux instance that has Node.js installed.
600600

601601
The [code source of this tutorial is available on GitHub](https://github.com/strapi/strapi-examples/tree/master/gatsby-strapi-tutorial). To see it live, clone the repository, run `npm run setup`, start the Strapi server (`cd api && strapi start`) and the Gatsby server (`cd blog && npm run develop`).
602602

docs/blog/2018-10-04-journey-to-the-content-mesh/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ In Part 3, [The Rise of Modern Web Development](/blog/2018-10-11-rise-of-modern-
6565

6666
In Part 4, [Why Mobile Performance is Crucial](/blog/2018-10-16-why-mobile-performance-is-crucial), we’ll discuss the ROI of site speed, explore two modern, complementary trends for improving web performance and how website teams can get the best of both out of the box.
6767

68-
In our conclusion, [Creating Compelling Experiences](/blog/2018-10-18-creating-compelling-experiences), we’ll discuss a step-by-step approach for choosing a content architecture, modern development environment, a performance strategy -- and most importantly, choosing a "content mesh" that makes all the other choices easy. We’ll also explore how one clear option -- Gatsby -- emerges as the most feature-complete of any content mesh alternatives.
68+
In our conclusion, [Creating Compelling Experiences](/blog/2018-10-18-creating-compelling-content-experiences), we’ll discuss a step-by-step approach for choosing a content architecture, modern development environment, a performance strategy -- and most importantly, choosing a "content mesh" that makes all the other choices easy. We’ll also explore how one clear option -- Gatsby -- emerges as the most feature-complete of any content mesh alternatives.
6969

7070
## The Modern Website Landscape
7171

docs/blog/2018-10-12-uptick-docs-contributions-hacktoberfest/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Here is a summary of the “docs decision tree,” a tool we’ll use to make de
3333

3434
A doc qualifies to be in the .org site if it:
3535

36-
1. Deals with a piece of Gatsby-maintained software (e.g. pertains to code in the [Gatsby OSS repository](www.github.com/gatsbyjs/gatsby)), a core dependency of the code in the Gatsby OSS repo, or a third-party software that works well with Gatsby and is in high demand
36+
1. Deals with a piece of Gatsby-maintained software (e.g. pertains to code in the [Gatsby OSS repository](https://www.github.com/gatsbyjs/gatsby)), a core dependency of the code in the Gatsby OSS repo, or a third-party software that works well with Gatsby and is in high demand
3737

3838
> **Yes** --> Belongs in the docs (to make sure we don’t have to maintain docs about core dependencies and third-party software, we will focus on linking to their docs as much as possible)
3939

docs/blog/2018-10-16-why-mobile-performance-is-crucial/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ For example, if you use a CDN to serve 3MB Javascript bundles, your site is stil
112112
<figure>
113113
<img alt="" src="./network-requests-adobe-com.png" />
114114
<figcaption>
115-
Part of a network request waterfall chart for a typical enterprise website (<a href="www.adobe.com">adobe.com</a>). The full waterfall chart is three times longer.
115+
Part of a network request waterfall chart for a typical enterprise website (<a href="https://www.adobe.com">adobe.com</a>). The full waterfall chart is three times longer.
116116
</figcaption>
117117
</figure>
118118

docs/blog/2018-2-6-choosing-a-back-end/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You build your site. You’ve got your Sass, you’ve got your Markdown files (o
3333

3434
Now we need a system to manage and deliver our content in a nice API (instructed by our GraphQL of course). And there’s a whole bunch of them about. To help us out, Gatsby has plugins that cater to some Headless CMS like the WordPress API, Contentful, Cockpit, Prismic and NetlifyCMS - which Gatsby actually has a guide for. I’ll be going through a few of these to see which one might be more useful for this small project, and going forward.
3535

36-
> After posting this, I heard some really good thing about [GraphCMS](https://graphcms.com/) - It’s designed to work with GraphQL inherently and they have a [Gatsby Starter Project](https://github.com/GraphCMS/graphcms-examples/tree/master/gatsby-source-plugin-blog) example to check out.
36+
> After posting this, I heard some really good thing about [GraphCMS](https://graphcms.com/) - It’s designed to work with GraphQL inherently and they have a [Gatsby Starter Project](https://github.com/GraphCMS/graphcms-examples/tree/master/current/gatsby-source-plugin-blog) example to check out.
3737
3838
Firstly, though, why do we want a Headless CMS and a JAMstack for the project? There are a few reasons most people use them, and some that are down to personal preference:
3939

docs/docs/gatsby-style-guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ topic to write about it--this entire website is open source, so even if you make
4141

4242
If you’d like to help by writing an article, find a stub article in the Gatsby
4343
Docs (with a grey instead of black title in the sidebar of the Docs), write the article, then
44-
[open a pull request (PR)](/how-to-contribute/#contributing-to-the-documentation) in the Gatsby GitHub repo to replace the stub with your article.
44+
[open a pull request (PR)](/docs/how-to-contribute/#contributing-to-the-documentation) in the Gatsby GitHub repo to replace the stub with your article.
4545

4646
If you can't find a stub about the topic you'd like to write about, you can open a PR in GitHub that creates the stub and includes your draft article. Feel free to ask questions in the PR comments if you're not sure where to put a new article in the directory structure.
4747

@@ -52,13 +52,13 @@ Before you begin writing, make sure to read the rest of this style guide.
5252
Docs can cover a broad range of topics. Please see the following
5353
examples:
5454

55-
- [guides](/add-404-page/)
56-
- [guide overviews](/styling/)
55+
- [guides](/docs/add-404-page/)
56+
- [guide overviews](/docs/styling/)
5757
- [tutorials](/tutorial/part-one/)
5858
- [plugin READme](/packages/gatsby-source-filesystem/)
5959
- [starter READme](https://github.com/gatsbyjs/gatsby-starter-default)
6060

61-
Please see the [Docs templates](docs/templates/) for guidelines on how to format the above kinds of documents.
61+
Please see the [Docs templates](/docs/templates/) for guidelines on how to format the above kinds of documents.
6262

6363
## Writing process
6464

docs/docs/headless-cms.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ The guides in this section will walk through the process of setting up content s
1717

1818
Other CMS systems you can connect to include:
1919

20-
- [ButterCMS](https://www.gatsbyjs.org/packages/gatsby-source-buttercms/?=gatsby-source-)
21-
- [Shopify](https://www.gatsbyjs.org/packages/gatsby-source-shopify/?=gatsby-source-)
22-
- [Contentstack](https://www.gatsbyjs.org/packages/gatsby-source-contentstack/?=gatsby-source-)
23-
- [Ghost](https://www.gatsbyjs.org/packages/gatsby-source-ghost/?=gatsby-source-)
24-
- [Prismic](https://www.gatsbyjs.org/packages/gatsby-source-prismic/?=gatsby-source-)
25-
- [Strapi](https://www.gatsbyjs.org/packages/gatsby-source-strapi/?=gatsby-source-)
26-
- [Directus](https://www.gatsbyjs.org/packages/gatsby-source-directus/?=gatsby-source-)
27-
- [Cockpit](https://www.gatsbyjs.org/packages/gatsby-plugin-cockpit/?=gatsby-source-)
28-
- [GraphCMS](https://www.gatsbyjs.org/packages/gatsby-source-graphcms-beta-patch/?=gatsby-source-)
29-
- [CraftCMS](https://www.gatsbyjs.org/packages/gatsby-source-craftcms/?=gatsby-source-)
30-
- [DatoCMS](https://www.gatsbyjs.org/packages/gatsby-source-datocms/?=gatsby-source-)
31-
- [Storyblok](https://www.gatsbyjs.org/packages/gatsby-source-storyblok/?=gatsby-source-)
32-
- [Kentico Cloud](https://www.gatsbyjs.org/packages/gatsby-source-kentico-cloud/?=gatsby-source-)
20+
- [ButterCMS](https://www.gatsbyjs.org/packages/gatsby-source-buttercms)
21+
- [Shopify](https://www.gatsbyjs.org/packages/gatsby-source-shopify)
22+
- [Contentstack](https://www.gatsbyjs.org/packages/gatsby-source-contentstack)
23+
- [Ghost](https://www.gatsbyjs.org/packages/gatsby-source-ghost)
24+
- [Prismic](https://www.gatsbyjs.org/packages/gatsby-source-prismic)
25+
- [Strapi](https://www.gatsbyjs.org/packages/gatsby-source-strapi)
26+
- [Directus](https://www.gatsbyjs.org/packages/gatsby-source-directus)
27+
- [Cockpit](https://www.gatsbyjs.org/packages/gatsby-plugin-cockpit)
28+
- [GraphCMS](https://www.gatsbyjs.org/packages/gatsby-source-graphcms-beta-patch)
29+
- [CraftCMS](https://www.gatsbyjs.org/packages/gatsby-source-craftcms)
30+
- [DatoCMS](https://www.gatsbyjs.org/packages/gatsby-source-datocms)
31+
- [Storyblok](https://www.gatsbyjs.org/packages/gatsby-source-storyblok)
32+
- [Kentico Cloud](https://www.gatsbyjs.org/packages/gatsby-source-kentico-cloud)
3333

3434
## How to add new guides to this section
3535

docs/docs/migrating-from-v1-to-v2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -733,7 +733,7 @@ exports.onCreateWebpackConfig = ({ getConfig, actions }) => {
733733
}
734734
```
735735
736-
If you're using a preprocessor, you can pass in CSS Loader options when configuring [`gatsby-plugin-sass`](/packages/gatsby-plugin-sass/README.md#how-to-use) or [`gatsby-plugin-less`](/packages/gatsby-plugin-less/README.md#how-to-use):
736+
If you're using a preprocessor, you can pass in CSS Loader options when configuring [`gatsby-plugin-sass`](/packages/gatsby-plugin-sass/#how-to-use) or [`gatsby-plugin-less`](/packages/gatsby-plugin-less/#how-to-use):
737737

738738
```javascript
739739
// in gatsby-config.js

docs/docs/sourcing-from-private-apis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ There are 3 approaches that you can use to source data from your private API:
1616

1717
1. If the data of your private API is updated very frequently or the expectation of the site is to be updated in real-time, it may make more sense to query the data directly during runtime.
1818

19-
2. If you can source the data through a plugin, consider that as an alternative to sourcing via the API. For instance, if you have access to the MongoDB database that stores the data, [`gatsby-source-mongodb`](/https://www.gatsbyjs.org/packages/gatsby-source-mongodb/) will be handy. Browse the [Gatsby Plugin Library](https://www.gatsbyjs.org/plugins/) to see what plugins that you could utilize.
19+
2. If you can source the data through a plugin, consider that as an alternative to sourcing via the API. For instance, if you have access to the MongoDB database that stores the data, [`gatsby-source-mongodb`](https://www.gatsbyjs.org/packages/gatsby-source-mongodb/) will be handy. Browse the [Gatsby Plugin Library](https://www.gatsbyjs.org/plugins/) to see what plugins that you could utilize.
2020

2121
3. Depending on your build process and the availability of your private API, you may need to make other adjustments accordingly.
2222

docs/docs/webpack-and-ssr.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ The next stages of the build lean heavily on webpack for code optimization and c
1010

1111
All the files required by webpack are in your site's `.cache` directory. This is empty when you initialize a new project and can be safely deleted. Gatsby creates and fills it over the course of a build.
1212

13-
At the start of the build, Gatsby [copies all files](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/src/bootstrap/index.js#L191) in [gatsby/cache-dir](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby/cache-dir) into your `.cache` directory. This includes things like [static-entry.js](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/cache-dir/static-entry.jsO) and [production-app.js](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/cache-dir/production-app.js) that you'll read about in the next sections. Essentially, all files that are needed by Gatsby to run in the browser, or to generate HTML, are included in `cache-dir`.
13+
At the start of the build, Gatsby [copies all files](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/src/bootstrap/index.js#L191) in [gatsby/cache-dir](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby/cache-dir) into your `.cache` directory. This includes things like [static-entry.js](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/cache-dir/static-entry.js) and [production-app.js](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/cache-dir/production-app.js) that you'll read about in the next sections. Essentially, all files that are needed by Gatsby to run in the browser, or to generate HTML, are included in `cache-dir`.
1414

1515
Since Webpack doesn't know about Redux, we also need to create files that contain all the page data that was built up during bootstrap. And these all need to be placed in `.cache` as well. This is what the previous [Write Out Pages](/docs/write-pages/) section dealt with.

packages/gatsby-plugin-layout/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ module.exports = {
5050
5151
There are a few scenarios where it makes sense to reimplement the V1 layout handling:
5252
53-
1. You have a large or complex V1 site and [refactoring to the new layout component](https://v2--gatsbyjs.netlify.com/docs/migrating-from-v1-to-v2/#update-layout-component) is not feasible
53+
1. You have a large or complex V1 site and [refactoring to the new layout component](https://www.gatsbyjs.org/docs/migrating-from-v1-to-v2/#remove-or-refactor-layout-components) is not feasible
5454
2. Your site uses page transitions or other transitions that break if the layout component is unmounted and remounted when routes change
5555
3. Your site attaches global state in the layout that doesn't persist if the component is unmounted and remounted
5656

0 commit comments

Comments
 (0)