Skip to content

Commit 99a1e29

Browse files
aar9nkaar9nk
committed
update docs url for actions
1 parent df69f04 commit 99a1e29

File tree

7 files changed

+42
-42
lines changed

7 files changed

+42
-42
lines changed

‎docs/docs/reference/release-notes/migrating-from-v2-to-v3.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ Add the following type definition to fix this:
597597
id: ID!
598598
}
599599
600-
https://www.gatsbyjs.com/docs/actions/#createTypes
600+
https://www.gatsbyjs.com/docs/reference/config-files/actions/#createTypes
601601
```
602602
603603
If you don't see any warnings, you are safe to upgrade to v3.
@@ -647,7 +647,7 @@ Add the following type definition to fix this:
647647
bar: [Bar] @link(by: "id", from: "bar___NODE")
648648
}
649649
650-
https://www.gatsbyjs.com/docs/actions/#createTypes
650+
https://www.gatsbyjs.com/docs/reference/config-files/actions/#createTypes
651651
```
652652
653653
If this warning is displayed for a type defined by some plugin, open an issue in the plugin repo

‎examples/using-local-plugins/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This example uses a [local plugin](/docs/loading-plugins-from-your-local-plugins
1414

1515
1. Load data from the PokéAPI’s REST endpoints
1616
2. Process that data into Gatsby's node format
17-
3. Use the [`createNode` action](/docs/actions/#createNode) to add the data to Gatsby’s GraphQL layer
17+
3. Use the [`createNode` action](/docs/reference/config-files/actions/#createNode) to add the data to Gatsby’s GraphQL layer
1818

1919
The [`gatsby-node.js` file](./plugins/gatsby-source-pokeapi/gatsby-node.js) of the local plugin includes detailed comments on the process.
2020

‎packages/gatsby-plugin-typescript/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This plugin is automatically included in Gatsby. The only reason you would need
1111
1. Run TypeScript directly or with a build tool.
1212
1. You're good to go.
1313

14-
> When [creating pages programmatically](/docs/programmatically-create-pages-from-data/#creating-pages), you can pass the `.tsx` filename directly as the `component` for [`createPage`](/docs/actions/#createPage).
14+
> When [creating pages programmatically](/docs/programmatically-create-pages-from-data/#creating-pages), you can pass the `.tsx` filename directly as the `component` for [`createPage`](/docs/reference/config-files/actions/#createPage).
1515
1616
_**Please note**: If packages don't ship with TypeScript definitions you'll need to manually install those type definitions, e.g. for React. A typical Gatsby project would need: `npm install --save-dev @types/react @types/react-dom @types/node`_
1717

‎packages/gatsby/index.d.ts

+24-24
Original file line numberDiff line numberDiff line change
@@ -1328,10 +1328,10 @@ export interface BuildArgs extends ParentSpanPluginArgs {
13281328
}
13291329

13301330
export interface Actions {
1331-
/** @see https://www.gatsbyjs.com/docs/actions/#deletePage */
1331+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#deletePage */
13321332
deletePage(this: void, args: { path: string; component: string }): void
13331333

1334-
/** @see https://www.gatsbyjs.com/docs/actions/#createPage */
1334+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createPage */
13351335
createPage<TContext = Record<string, unknown>>(
13361336
this: void,
13371337
args: Page<TContext>,
@@ -1347,21 +1347,21 @@ export interface Actions {
13471347
option?: ActionOptions
13481348
): void
13491349

1350-
/** @see https://www.gatsbyjs.com/docs/actions/#deleteNode */
1350+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#deleteNode */
13511351
deleteNode(node: NodeInput, plugin?: ActionPlugin): void
13521352

1353-
/** @see https://www.gatsbyjs.com/docs/actions/#createNode */
1353+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createNode */
13541354
createNode<TNode = Record<string, unknown>>(
13551355
this: void,
13561356
node: NodeInput & TNode,
13571357
plugin?: ActionPlugin,
13581358
options?: ActionOptions
13591359
): void | Promise<void>
13601360

1361-
/** @see https://www.gatsbyjs.com/docs/actions/#touchNode */
1361+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#touchNode */
13621362
touchNode(node: NodeInput, plugin?: ActionPlugin): void
13631363

1364-
/** @see https://www.gatsbyjs.com/docs/actions/#createNodeField */
1364+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createNodeField */
13651365
createNodeField(
13661366
this: void,
13671367
args: {
@@ -1373,7 +1373,7 @@ export interface Actions {
13731373
options?: ActionOptions
13741374
): void
13751375

1376-
/** @see https://www.gatsbyjs.com/docs/actions/#createParentChildLink */
1376+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createParentChildLink */
13771377
createParentChildLink(
13781378
this: void,
13791379
args: { parent: Node; child: NodeInput },
@@ -1391,44 +1391,44 @@ export interface Actions {
13911391
plugin?: ActionPlugin
13921392
): void
13931393

1394-
/** @see https://www.gatsbyjs.com/docs/actions/#setRequestHeaders */
1394+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setRequestHeaders */
13951395
setRequestHeaders(
13961396
this: void,
13971397
args: { domain: string; headers: Record<string, string> },
13981398
plugin?: ActionPlugin
13991399
): void
14001400

1401-
/** @see https://www.gatsbyjs.com/docs/actions/#setWebpackConfig */
1401+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setWebpackConfig */
14021402
setWebpackConfig(this: void, config: object, plugin?: ActionPlugin): void
14031403

1404-
/** @see https://www.gatsbyjs.com/docs/actions/#replaceWebpackConfig */
1404+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#replaceWebpackConfig */
14051405
replaceWebpackConfig(this: void, config: object, plugin?: ActionPlugin): void
14061406

1407-
/** @see https://www.gatsbyjs.com/docs/actions/#setBabelOptions */
1407+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setBabelOptions */
14081408
setBabelOptions(this: void, options: object, plugin?: ActionPlugin): void
14091409

1410-
/** @see https://www.gatsbyjs.com/docs/actions/#setBabelPlugin */
1410+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setBabelPlugin */
14111411
setBabelPlugin(
14121412
this: void,
14131413
config: { name: string; options: object },
14141414
plugin?: ActionPlugin
14151415
): void
14161416

1417-
/** @see https://www.gatsbyjs.com/docs/actions/#setBabelPreset */
1417+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setBabelPreset */
14181418
setBabelPreset(
14191419
this: void,
14201420
config: { name: string; options: object },
14211421
plugin?: ActionPlugin
14221422
): void
14231423

1424-
/** @see https://www.gatsbyjs.com/docs/actions/#createJob */
1424+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createJob */
14251425
createJob(
14261426
this: void,
14271427
job: Record<string, unknown> & { id: string },
14281428
plugin?: ActionPlugin
14291429
): void
14301430

1431-
/** @see https://www.gatsbyjs.com/docs/actions/#createJobV2 */
1431+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createJobV2 */
14321432
createJobV2(
14331433
this: void,
14341434
job: {
@@ -1440,27 +1440,27 @@ export interface Actions {
14401440
plugin?: ActionPlugin
14411441
): Promise<unknown>
14421442

1443-
/** @see https://www.gatsbyjs.com/docs/actions/#addGatsbyImageSourceUrl */
1443+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#addGatsbyImageSourceUrl */
14441444
addGatsbyImageSourceUrl(this: void, sourceUrl: string): void
14451445

1446-
/** @see https://www.gatsbyjs.com/docs/actions/#setJob */
1446+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setJob */
14471447
setJob(
14481448
this: void,
14491449
job: Record<string, unknown> & { id: string },
14501450
plugin?: ActionPlugin
14511451
): void
14521452

1453-
/** @see https://www.gatsbyjs.com/docs/actions/#endJob */
1453+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#endJob */
14541454
endJob(this: void, job: { id: string }, plugin?: ActionPlugin): void
14551455

1456-
/** @see https://www.gatsbyjs.com/docs/actions/#setPluginStatus */
1456+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#setPluginStatus */
14571457
setPluginStatus(
14581458
this: void,
14591459
status: Record<string, unknown>,
14601460
plugin?: ActionPlugin
14611461
): void
14621462

1463-
/** @see https://www.gatsbyjs.com/docs/actions/#createRedirect */
1463+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createRedirect */
14641464
createRedirect(
14651465
this: void,
14661466
redirect: {
@@ -1476,15 +1476,15 @@ export interface Actions {
14761476
plugin?: ActionPlugin
14771477
): void
14781478

1479-
/** @see https://www.gatsbyjs.com/docs/actions/#addThirdPartySchema */
1479+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#addThirdPartySchema */
14801480
addThirdPartySchema(
14811481
this: void,
14821482
args: { schema: object },
14831483
plugin?: ActionPlugin,
14841484
traceId?: string
14851485
): void
14861486

1487-
/** @see https://www.gatsbyjs.com/docs/actions/#createTypes */
1487+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createTypes */
14881488
createTypes(
14891489
this: void,
14901490
types:
@@ -1496,7 +1496,7 @@ export interface Actions {
14961496
traceId?: string
14971497
): void
14981498

1499-
/** @see https://www.gatsbyjs.com/docs/actions/#createFieldExtension */
1499+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createFieldExtension */
15001500
createFieldExtension(
15011501
this: void,
15021502
extension: object,
@@ -1521,7 +1521,7 @@ export interface Actions {
15211521
*/
15221522
enableStatefulSourceNodes?(this: void, plugin?: ActionPlugin): void
15231523

1524-
/** @see https://www.gatsbyjs.com/docs/actions/#addRemoteFileAllowedUrl */
1524+
/** @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#addRemoteFileAllowedUrl */
15251525
addRemoteFileAllowedUrl?(
15261526
this: void,
15271527
url: string | Array<string>,

‎packages/gatsby/src/schema/infer/type-conflict-reporter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ class TypeConflictReporter {
135135
`If you know all field types in advance, the best strategy is to ` +
136136
`explicitly define them with the \`createTypes\` action, and skip ` +
137137
`inference with the \`@dontInfer\` directive.\n` +
138-
`See https://www.gatsbyjs.com/docs/actions/#createTypes`
138+
`See https://www.gatsbyjs.com/docs/reference/config-files/actions/#createTypes`
139139
)
140140
this.entries.forEach(entry => entry.printEntry())
141141
}

‎packages/gatsby/src/utils/api-node-docs.ts

+12-12
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ export const resolvableExtensions = true
1212
*
1313
* You can also fetch data from remote or local sources to create pages.
1414
*
15-
* See also [the documentation for the action `createPage`](/docs/actions/#createPage).
15+
* See also [the documentation for the action `createPage`](/docs/reference/config-files/actions/#createPage).
1616
*
1717
* @param {object} $0 See the [documentation for `Node API Helpers` for more details](/docs/node-api-helpers)
18-
* @param {Actions} $0.actions See the [list of documented actions](/docs/actions)
19-
* @param {function} $0.actions.createPage [Documentation for this action](/docs/actions/#createPage)
18+
* @param {Actions} $0.actions See the [list of documented actions](/docs/reference/config-files/actions)
19+
* @param {function} $0.actions.createPage [Documentation for this action](/docs/reference/config-files/actions/#createPage)
2020
* @param {function} $0.graphql: Query GraphQL API. See [examples here](/docs/creating-and-modifying-pages/#creating-pages-in-gatsby-nodejs)
2121
* @param {GatsbyReporter} $0.reporter Log issues. See [GatsbyReporter documentation](/docs/node-api-helpers/#GatsbyReporter) for more details
2222
* @returns {Promise<void>} No return value required, but the caller will `await` any promise that's returned
@@ -100,7 +100,7 @@ export const createPagesStatefully = true
100100
* Plugin](/docs/how-to/plugins-and-themes/creating-a-source-plugin/) tutorial
101101
* demonstrates a way a plugin or site might use this API.
102102
*
103-
* See also the documentation for [`createNode`](/docs/actions/#createNode).
103+
* See also the documentation for [`createNode`](/docs/reference/config-files/actions/#createNode).
104104
* @example
105105
* exports.sourceNodes = ({ actions, createNodeId, createContentDigest }) => {
106106
* const { createNode } = actions
@@ -136,8 +136,8 @@ export const sourceNodes = true
136136
* Called when a new node is created. Plugins wishing to extend or
137137
* transform nodes created by other plugins should implement this API.
138138
*
139-
* See also the documentation for [`createNode`](/docs/actions/#createNode)
140-
* and [`createNodeField`](/docs/actions/#createNodeField)
139+
* See also the documentation for [`createNode`](/docs/reference/config-files/actions/#createNode)
140+
* and [`createNodeField`](/docs/reference/config-files/actions/#createNodeField)
141141
*
142142
* The [Creating a Source
143143
* Plugin](/docs/how-to/plugins-and-themes/creating-a-source-plugin/) tutorial
@@ -233,9 +233,9 @@ export const setFieldsOnGraphQLNodeType = true
233233
* Customize Gatsby's GraphQL schema by creating type definitions, field
234234
* extensions or adding third-party schemas.
235235
*
236-
* The [`createTypes`](/docs/actions/#createTypes),
237-
* [`createFieldExtension`](/docs/actions/#createFieldExtension) and
238-
* [`addThirdPartySchema`](/docs/actions/#addThirdPartySchema) actions
236+
* The [`createTypes`](/docs/reference/config-files/actions/#createTypes),
237+
* [`createFieldExtension`](/docs/reference/config-files/actions/#createFieldExtension) and
238+
* [`addThirdPartySchema`](/docs/reference/config-files/actions/#addThirdPartySchema) actions
239239
* are only available in this API. For details on their usage please refer to
240240
* the actions documentation.
241241
*
@@ -353,8 +353,8 @@ export const preprocessSource = true
353353

354354
/**
355355
* Let plugins extend/mutate the site's Babel configuration by calling
356-
* [`setBabelPlugin`](/docs/actions/#setBabelPlugin) or
357-
* [`setBabelPreset`](/docs/actions/#setBabelPreset).
356+
* [`setBabelPlugin`](/docs/reference/config-files/actions/#setBabelPlugin) or
357+
* [`setBabelPreset`](/docs/reference/config-files/actions/#setBabelPreset).
358358
* @param {object} $0
359359
* @param {string} $0.stage The current build stage. One of 'develop', 'develop-html',
360360
* 'build-javascript', or 'build-html'
@@ -373,7 +373,7 @@ export const onCreateBabelConfig = true
373373
/**
374374
* Let plugins extend/mutate the site's webpack configuration. This method can be used by any Gatsby site, app, or plugin, not just plugins.
375375
*
376-
* See also the documentation for [`setWebpackConfig`](/docs/actions/#setWebpackConfig).
376+
* See also the documentation for [`setWebpackConfig`](/docs/reference/config-files/actions/#setWebpackConfig).
377377
*
378378
* @param {object} $0
379379
* @param {string} $0.stage The current build stage. One of 'develop', 'develop-html',

‎packages/gatsby/src/utils/api-node-helpers-docs.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ module.exports.createContentDigest = true;
192192
/**
193193
* Collection of functions used to programmatically modify Gatsby’s internal state.
194194
*
195-
* See [`actions`](/docs/actions/) reference.
195+
* See [`actions`](/docs/reference/config-files/actions/) reference.
196196
* @type {Actions}
197197
*/
198198
module.exports.actions = true;

0 commit comments

Comments
 (0)