From 73a32ec93838ee5bd14210ff9473d2bbe1e7f108 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 9 Mar 2021 14:21:43 +0100 Subject: [PATCH] Fix broken relatives links with /designers-developers/ base path --- README.md | 2 +- docs/getting-started/faq.md | 2 +- docs/reference-guides/block-api/block-registration.md | 2 +- docs/reference-guides/slotfills/README.md | 4 ++-- packages/block-editor/src/components/inner-blocks/README.md | 4 ++-- .../block-editor/src/components/inspector-controls/README.md | 2 +- packages/components/src/toolbar-button/README.md | 4 ++-- packages/components/src/toolbar-item/README.md | 4 ++-- packages/create-block-tutorial-template/README.md | 2 +- packages/create-block-tutorial-template/package.json | 2 +- packages/notices/README.md | 2 +- packages/scripts/README.md | 2 +- 12 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a6deb85dd4774..3f6d7d3619932 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Get hands on: check out the [block editor live demo](https://wordpress.org/guten Extending and customizing is at the heart of the WordPress platform, this is no different for the Gutenberg project. The editor and future products can be extended by third-party developers using plugins. -Review the [Create a Block tutorial](/docs/designers-developers/developers/tutorials/create-block/README.md) for the fastest way to get started extending the block editor. See the [Developer Documentation](https://developer.wordpress.org/block-editor/developers/) for extensive tutorials, documentation, and API references. +Review the [Create a Block tutorial](/docs/getting-started/tutorials/create-block/README.md) for the fastest way to get started extending the block editor. See the [Developer Documentation](https://developer.wordpress.org/block-editor/developers/) for extensive tutorials, documentation, and API references. ### Contribute to Gutenberg diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index d4ca067e40c37..aba712e9b0b17 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -324,7 +324,7 @@ This is currently a work in progress and we recommend reviewing the [block based ## What are block variations? Are they the same as block styles? -No, [block variations](/docs/designers-developers/developers/block-api/block-variations.md) are different versions of a single base block, sharing a similar functionality, but with slight differences in their implementation, or settings (attributes, InnerBlocks,etc). Block variations are transparent for users, and once there is a registered block variation, it will appear as a new block. For example, the `embed` block registers different block variations to embed content from specific providers. +No, [block variations](/docs/reference-guides/block-api/block-variations.md) are different versions of a single base block, sharing a similar functionality, but with slight differences in their implementation, or settings (attributes, InnerBlocks,etc). Block variations are transparent for users, and once there is a registered block variation, it will appear as a new block. For example, the `embed` block registers different block variations to embed content from specific providers. Meanwhile, [block styles](/docs/reference-guides/filters/block-filters.md#block-style-variations) allow you to provide alternative styles to existing blocks, and they work by adding a className to the block’s wrapper. Once a block has registered block styles, a block style selector will appear in its sidebar so that users can choose among the different registered styles. diff --git a/docs/reference-guides/block-api/block-registration.md b/docs/reference-guides/block-api/block-registration.md index 31cadb9c74de7..5ac9d2a3e78bb 100644 --- a/docs/reference-guides/block-api/block-registration.md +++ b/docs/reference-guides/block-api/block-registration.md @@ -224,7 +224,7 @@ example: { - **Type:** `Object[]` -Similarly to how the block's style variations can be declared, a block type can define block variations that the user can pick from. The difference is that, rather than changing only the visual appearance, this field provides a way to apply initial custom attributes and inner blocks at the time when a block is inserted. See the [Block Variations API](/docs/designers-developers/developers/block-api/block-variations.md) for more details. +Similarly to how the block's style variations can be declared, a block type can define block variations that the user can pick from. The difference is that, rather than changing only the visual appearance, this field provides a way to apply initial custom attributes and inner blocks at the time when a block is inserted. See the [Block Variations API](/docs/reference-guides/block-api/block-variations.md) for more details. diff --git a/docs/reference-guides/slotfills/README.md b/docs/reference-guides/slotfills/README.md index da88e6cb7661e..130b058c5db65 100644 --- a/docs/reference-guides/slotfills/README.md +++ b/docs/reference-guides/slotfills/README.md @@ -1,9 +1,9 @@ # SlotFills Reference Slot and Fill are components that have been exposed to allow developers to inject items into some predefined places in the Gutenberg admin experience. -Please see the [SlotFill component docs](https://wordpress.org/gutenberg/handbook/designers-developers/developers/components/slot-fill/) for more details. +Please see the [SlotFill component docs](https://wordpress.org/gutenberg/handbook/reference-guides/components/slot-fill/) for more details. -In order to use them, we must leverage the [@wordpress/plugins](https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-plugins/) api to register a plugin that will inject our items. +In order to use them, we must leverage the [@wordpress/plugins](https://wordpress.org/gutenberg/handbook/reference-guides/packages/packages-plugins/) api to register a plugin that will inject our items. ## Usage overview diff --git a/packages/block-editor/src/components/inner-blocks/README.md b/packages/block-editor/src/components/inner-blocks/README.md index 1466c8a59a095..8cae0693f60fb 100644 --- a/packages/block-editor/src/components/inner-blocks/README.md +++ b/packages/block-editor/src/components/inner-blocks/README.md @@ -85,7 +85,7 @@ While this prop doesn't change any styles for the inner blocks themselves, it do * **Type:** `Array>` The template is defined as a list of block items. Such blocks can have predefined attributes, placeholder, content, etc. Block templates allow specifying a default initial state for an InnerBlocks area. -More information about templates can be found in [template docs](/docs/designers-developers/developers/block-api/block-templates.md). +More information about templates can be found in [template docs](/docs/reference-guides/block-api/block-templates.md). ```jsx const TEMPLATE = [ [ 'core/columns', {}, [ @@ -114,7 +114,7 @@ If false the selection should not be updated when child blocks specified in the ### `templateLock` * **Type:** `String|Boolean` -Template locking of `InnerBlocks` is similar to [Custom Post Type templates locking](/docs/designers-developers/developers/block-api/block-templates.md#locking). +Template locking of `InnerBlocks` is similar to [Custom Post Type templates locking](/docs/reference-guides/block-api/block-templates.md#locking). Template locking allows locking the `InnerBlocks` area for the current template. *Options:* diff --git a/packages/block-editor/src/components/inspector-controls/README.md b/packages/block-editor/src/components/inspector-controls/README.md index ac1520de6975b..3369cc8002c9f 100644 --- a/packages/block-editor/src/components/inspector-controls/README.md +++ b/packages/block-editor/src/components/inspector-controls/README.md @@ -1,6 +1,6 @@ # InspectorControls -inspector +inspector Inspector Controls appear in the post settings sidebar when a block is being edited. The controls appear in both HTML and visual editing modes, and thus should contain settings that affect the entire block. diff --git a/packages/components/src/toolbar-button/README.md b/packages/components/src/toolbar-button/README.md index 1ddccac0c75fa..6595b98c10d44 100644 --- a/packages/components/src/toolbar-button/README.md +++ b/packages/components/src/toolbar-button/README.md @@ -1,6 +1,6 @@ # ToolbarButton -ToolbarButton can be used to add actions to a toolbar, usually inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md). +ToolbarButton can be used to add actions to a toolbar, usually inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). It has similar features to the [Button](/packages/components/src/button/README.md) component. Using `ToolbarButton` will ensure the correct styling for a button in a toolbar, and also that keyboard interactions in a toolbar are consistent with the [WAI-ARIA toolbar pattern](https://www.w3.org/TR/wai-aria-practices/#toolbar). @@ -27,7 +27,7 @@ function MyToolbar() { ### Inside BlockControls -If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). +If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). ```jsx import { BlockControls } from '@wordpress/block-editor'; diff --git a/packages/components/src/toolbar-item/README.md b/packages/components/src/toolbar-item/README.md index 1df563778a0e1..16ce9ff7a414d 100644 --- a/packages/components/src/toolbar-item/README.md +++ b/packages/components/src/toolbar-item/README.md @@ -1,6 +1,6 @@ # ToolbarItem -A ToolbarItem is a generic headless component that can be used to make any custom component a [Toolbar](/packages/components/src/toolbar/README.md) item. It should be inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md). +A ToolbarItem is a generic headless component that can be used to make any custom component a [Toolbar](/packages/components/src/toolbar/README.md) item. It should be inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). ## Usage @@ -49,7 +49,7 @@ function MyToolbar() { ### Inside BlockControls -If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). +If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). ```jsx import { BlockControls } from '@wordpress/block-editor'; diff --git a/packages/create-block-tutorial-template/README.md b/packages/create-block-tutorial-template/README.md index a84c5fdb8ec8b..cb689139aeebd 100644 --- a/packages/create-block-tutorial-template/README.md +++ b/packages/create-block-tutorial-template/README.md @@ -1,6 +1,6 @@ # Create Block Tutorial Template -This is a template for [`@wordpress/create-block`](/packages/create-block/README.md) that is the finished version of the block in the official [WordPress Tutorial](/docs/designers-developers/developers/tutorials/create-block/README.md) for the block editor. +This is a template for [`@wordpress/create-block`](/packages/create-block/README.md) that is the finished version of the block in the official [WordPress Tutorial](/docs/getting-started/tutorials/create-block/README.md) for the block editor. ## Usage diff --git a/packages/create-block-tutorial-template/package.json b/packages/create-block-tutorial-template/package.json index 4b0fd09ff1820..09d45b5526cfd 100644 --- a/packages/create-block-tutorial-template/package.json +++ b/packages/create-block-tutorial-template/package.json @@ -9,7 +9,7 @@ "create block", "block template" ], - "homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/docs/designers-developers/developers/tutorials/create-block", + "homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/docs/getting-started/tutorials/create-block", "repository": { "type": "git", "url": "https://github.com/WordPress/gutenberg.git", diff --git a/packages/notices/README.md b/packages/notices/README.md index 497f10042e255..dd44b0fb8e505 100644 --- a/packages/notices/README.md +++ b/packages/notices/README.md @@ -20,6 +20,6 @@ When imported, the notices module registers a data store on the `core/notices` n For more information about consuming from a data store, refer to [the `@wordpress/data` documentation on _Data Access and Manipulation_](/packages/data/README.md#data-access-and-manipulation). -For a full list of actions and selectors available in the `core/notices` namespace, refer to the [_Notices Data_ Handbook page](/docs/designers-developers/developers/data/data-core-notices.md). +For a full list of actions and selectors available in the `core/notices` namespace, refer to the [_Notices Data_ Handbook page](/docs/reference-guides/data/data-core-notices.md).

Code is Poetry.

diff --git a/packages/scripts/README.md b/packages/scripts/README.md index f846cce638417..4eddc4f55bffc 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -44,7 +44,7 @@ _Example:_ } ``` -It might also be a good idea to get familiar with the [JavaScript Build Setup tutorial](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) for setting up a development environment to use ESNext syntax. It gives a very in-depth explanation of how to use the [build](#build) and [start](#start) scripts. +It might also be a good idea to get familiar with the [JavaScript Build Setup tutorial](/docs/how-to-guides/javascript/js-build-setup.md) for setting up a development environment to use ESNext syntax. It gives a very in-depth explanation of how to use the [build](#build) and [start](#start) scripts. ## Updating to New Release