Skip to content

Commit 416a216

Browse files
jakob-stoeckDSchau
authored andcommitted
fixes broken links in docs (#11058)
There were some broken links which are fixed with this PR. Is there a way to check for internal and/or external broken links at build time with Gatsby? There are some remaining broken links, mainly due to outdated packages. Those can be found with an online broken links checker: - The dependency `gatsby-plugin-google-fonts` linked in https://www.gatsbyjs.org/starters/ericwindmill/gatsby-starter-docs/ does not exist anymore in this repo. Link to its [npm package](https://www.npmjs.com/package/gatsby-plugin-google-fonts)? - Several links from packages I cannot find in the current master branch: - https://www.gatsbyjs.org/packages/gatsby-plugin-purgecss/LICENSE - https://www.gatsbyjs.org/packages/gatsby-source-ghost/LICENSE - https://www.gatsbyjs.org/packages/gatsby-plugin-matomo/CHANGELOG.md - https://www.gatsbyjs.org/packages/gatsby-source-stripe/CODE_OF_CONDUCT.md - https://www.gatsbyjs.org/packages/gatsby-source-stripe/CONTRIBUTING.md - https://www.gatsbyjs.org/packages/gatsby-source-craftcms/ links to https://github.com/gusnips/gatsby-craftcms-example but should link to https://github.com/gusnips/gatsby-source-craftcms (refresh repo?) <!-- Have any questions? Check out the contributing docs at https://gatsby.app/contribute, or ask in this Pull Request and a Gatsby maintainer will be happy to help :) --> ## Description <!-- Write a brief description of the changes introduced by this PR --> ## Related Issues <!-- Link to the issue that is fixed by this PR (if there is one) e.g. Fixes #1234, Addresses #1234, Related to #1234, etc. -->
1 parent 73b45ec commit 416a216

File tree

11 files changed

+12
-12
lines changed

11 files changed

+12
-12
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Caching a traditional CMS website is another possibility -- though this often cr
132132

133133
But if delivery optimization is _hard_, payload optimization can be _near impossible_ to deliver within time and budget for many agencies and enterprises.
134134

135-
Comprehensive checklists [weigh in at around 40 items](https://www.smashingmagazine.com/2018/01/frontend-performance-checklist-2018-pdf-pages/), including points like route-based code splitting, HTTP/2 asset serving, background prefetching, lazy-loading non-critical assets, service workers, dead code elimination, and server-side rendering. Each of these points is technically feasible but quite rare.
135+
Comprehensive checklists [weigh in at around 40 items](https://www.smashingmagazine.com/2019/01/front-end-performance-checklist-2019-pdf-pages/), including points like route-based code splitting, HTTP/2 asset serving, background prefetching, lazy-loading non-critical assets, service workers, dead code elimination, and server-side rendering. Each of these points is technically feasible but quite rare.
136136

137137
Among the many implementation challenges are:
138138

docs/blog/2018-10-18-creating-compelling-content-experiences/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Often, to ensure a fast site, you'll need both.
5353

5454
To do delivery optimization, you'll need to pick a JAMStack site generator like Hugo or Gatsby.
5555

56-
To do payload optimization, your team will need to implement a [long performance checklist](https://www.smashingmagazine.com/2018/01/frontend-performance-checklist-2018-pdf-pages/), or pick a framework such as Gatsby that [performs payload optimization](https://www.gatsbyjs.org/features/#legend) out of the box.
56+
To do payload optimization, your team will need to implement a [long performance checklist](https://www.smashingmagazine.com/2019/01/front-end-performance-checklist-2019-pdf-pages/), or pick a framework such as Gatsby that [performs payload optimization](https://www.gatsbyjs.org/features/#legend) out of the box.
5757

5858
### Fourth, choose your content mesh
5959

docs/blog/2018-12-31-how-we-do-high-impact-ux-research/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,4 @@ Sign up for a 15, 30, or 60 minute interview to tell me your experiences with Ga
143143

144144
## Know someone who has never used Gatsby before?
145145

146-
If you know someone who might like to get an Amazon gift card for participating in a usability test for first-time visitors to Gatsby, [submit your contact info and your friend’s contact info here!](https://docs.google.com/forms/d/e/1FAIpQLSeP4Z-7OnBeR2gyaLOu-N9GHQ59EFhIPqvzdp0UU70Fj4Bw2w/viewfor)
146+
If you know someone who might like to get an Amazon gift card for participating in a usability test for first-time visitors to Gatsby, [submit your contact info and your friend’s contact info here!](https://docs.google.com/forms/d/e/1FAIpQLSeP4Z-7OnBeR2gyaLOu-N9GHQ59EFhIPqvzdp0UU70Fj4Bw2w/viewform)

docs/blog/2018-2-27-why-i-upgraded-my-website-to-gatsbyjs-from-jekyll/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ As I had some free time on my hands, why not rewrite everything again and keep m
3636

3737
## Final Form — Gatsby
3838

39-
[Gatsby](https://www.gatsbyjs.org/) is a static site generator that can render sites from markup documents using templates defined as React components. It functions similarly to Jekyll, where you can pick a [starter project](https://github.com/gatsbyjs/gatsby-starter-blog), [drop in](https://github.com/gatsbyjs/gatsby-starter-blog/blob/master/src/pages/hello-world/index.md) some markdown documents for articles, and [be rewarded](https://gatsbyjs.github.io/gatsby-starter-blog/) with a website with minimal effort.
39+
[Gatsby](https://www.gatsbyjs.org/) is a static site generator that can render sites from markup documents using templates defined as React components. It functions similarly to Jekyll, where you can pick a [starter project](https://github.com/gatsbyjs/gatsby-starter-blog), [drop in](https://github.com/gatsbyjs/gatsby-starter-blog/blob/master/content/blog/hello-world/index.md) some markdown documents for articles, and [be rewarded](https://gatsbyjs.github.io/gatsby-starter-blog/) with a website with minimal effort.
4040

4141
It offers much much more, however. Gatsby lets me leverage all the modern tools for building web applications and to add interactive experiences for visitors like a fully fledged [React](https://reactjs.org/) application. Not only that, it is unlike traditional single page applications, and works _without_ JavaScript! Things would certainly be more complicated if I were to add a JavaScript compilation pipeline to a Jekyll site, and a JavaScript framework would be a better fit.
4242

docs/docs/api-proxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Proxying API Requests in Development"
44

55
## Resources
66

7-
If you’re not familiar with Gatsby’s lifecycle, see the overview [Gatsby Lifecycle APIs](/gatsby-lifecycle-apis/).
7+
If you’re not familiar with Gatsby’s lifecycle, see the overview [Gatsby Lifecycle APIs](/docs/gatsby-lifecycle-apis/).
88

99
## Proxying API requests in development
1010

docs/docs/api-specification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on the back burner btw until after v1 comes out).
1111

1212
## Prerequisites
1313

14-
If you’re not familiar with Gatsby’s lifecycle, see the overview [Gatsby Lifecycle APIs](/gatsby-lifecycle-apis/).
14+
If you’re not familiar with Gatsby’s lifecycle, see the overview [Gatsby Lifecycle APIs](/docs/gatsby-lifecycle-apis/).
1515

1616
## Plugins
1717

docs/docs/debugging-replace-renderer-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Debugging replaceRenderer API
44

55
## Prerequisites
66

7-
If you’re not familiar with Gatsby’s lifecycle, see the overview [Gatsby Lifecycle APIs](/gatsby-lifecycle-apis/).
7+
If you’re not familiar with Gatsby’s lifecycle, see the overview [Gatsby Lifecycle APIs](/docs/gatsby-lifecycle-apis/).
88

99
## What is the `replaceRenderer` API?
1010

docs/docs/how-to-label-an-issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Anyone who's a member of the [Gatsby Maintainers team](https://github.com/orgs/g
2424

2525
You can get an invite to the team by having a Pull Request merged into the Gatsby project. Check out the list of [`help wanted`](https://github.com/gatsbyjs/gatsby/labels/%F0%9F%93%8D%20status%3A%20help%20wanted) issues and the [How To Contribute Guide](/docs/how-to-contribute/) to get started.
2626

27-
**NOTE:** If you’ve already had a pull request merged and you have _not_ been invited to the maintainers team, please go to [the dashboard](https://store.gatsbyjs.org/account/dashboard) and request a discount code. You should get an invite to the team — _and you get free Gatsby swag!_ If that doesn’t work, please email [email protected] and we'll get you invited.
27+
**NOTE:** If you’ve already had a pull request merged and you have _not_ been invited to the maintainers team, please go to [the dashboard](https://store.gatsbyjs.org/) and request a discount code. You should get an invite to the team — _and you get free Gatsby swag!_ If that doesn’t work, please email [email protected] and we'll get you invited.
2828

2929
## How to label an issue
3030

docs/docs/static-vs-normal-queries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ TODO: in query-watcher.js/handleQuery, we remove jsonName from dataDependencies.
3333

3434
### Usages
3535

36-
- [websocket-manager](TODO). TODO
37-
- [query-watcher](TODO).
36+
- [websocket-manager](#TODO). TODO
37+
- [query-watcher](#TODO).
3838

3939
- `getQueriesSnapshot` returns map with snapshot of `state.staticQueryComponents`
4040
- handleComponentsWithRemovedQueries. For each staticQueryComponent, if passed in queries doesn't include `staticQueryComponent.componentPath`. TODO: Where is StaticQueryComponent created? TODO: Where is queries passed into `handleComponentsWithRemovedQueries`?

docs/features/gatsby-specs.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Performance,Faster content delivery,Static content,3,3,1,2,"Can you build your s
2121
Gatsby supports this out of the box; adoption is possible with <a href=""https://fossbytes.com/get-jekyll-blog-work-offline/"" target=""_blank"">Jekyll</a> and <a href=""https://wordpress.org/plugins/offline-content/"">WordPress</a>. Squarespace <a href=""https://answers.squarespace.com/questions/56762/i-need-to-run-a-demo-of-my-squarespace-website-offline.html"">doesn't currently support</a> any offline access."
2222
,,Prefetch linked pages,3,1,1,0,"<p>Gatsby supports content pre-fetching, out of the box. This means that when a page loads, the content needed to load the next link you click will be loaded in the background while you browse the page.</p>
2323

24-
<p>You can put this together in <a href=""https://stackoverflow.com/questions/9951179/this-is-my-jekyll-with-hash-routing-setup-strategy-is-there-a-better-way"" target=""_blank>Jekyll</a>. The situation is <a href=""https://trevan.co/observations-on-frontend-routing-wordpress/"">considerably more tricky</a> for WordPress & requires maintaining dual PHP and JS templates.</p> "
24+
<p>You can put this together in <a href=""https://stackoverflow.com/questions/9951179/this-is-my-jekyll-with-hash-routing-setup-strategy-is-there-a-better-way"" target=""_blank>Jekyll</a>. The situation is <a href=""https://trevan.co/observations-on-front-end-routing-wordpress/"">considerably more tricky</a> for WordPress & requires maintaining dual PHP and JS templates.</p> "
2525
,,Page caching,3,3,2,0,"<p>Fingerprinting static resources that aren't expected to change lets browsers serve content locally when a user visits a page they've already been to, as opposed to making an extra network call.</p>
2626
<p>Gatsby and Jekyll support this out of the box, while WordPress allows this via plugins and Squarespace <a href=""https://answers.squarespace.com/questions/173452/enabling-browser-cache-for-sqaurespace-site.html"">doesn't allow it</a> at all.</p>"
2727
,,No extraneous code fetching,3,3,3,3,Extraneous code fetches are typically done by single-page applications written in various JS frameworks; on page load they fetch the code needed to run the entire application rather than just the page that's loaded. Website-building frameworks tend to be fiine on this.

0 commit comments

Comments
 (0)