From 988893a58b18099f952008a3af1bdd492eb3bebe Mon Sep 17 00:00:00 2001 From: Aki Hamano <54422211+t-hamano@users.noreply.github.com> Date: Tue, 4 Apr 2023 21:11:29 +0900 Subject: [PATCH] Docs: fix redirected links to user documents (#49537) * Docs: fix redirected links to user documents * Update packages/edit-site/src/components/welcome-guide/styles.js Co-authored-by: Alex Stine --------- Co-authored-by: Alex Stine --- .github/SUPPORT.md | 2 +- README.md | 4 ++-- docs/README.md | 2 +- .../code/getting-started-with-code-contribution.md | 2 +- docs/contributors/documentation/README.md | 2 +- docs/how-to-guides/propagating-updates.md | 2 +- docs/how-to-guides/themes/theme-json.md | 2 +- .../src/components/date-format-picker/index.js | 2 +- packages/block-editor/src/hooks/anchor.js | 2 +- .../src/embed/embed-link-settings.native.js | 2 +- .../block-library/src/embed/embed-placeholder.js | 2 +- packages/create-block/README.md | 14 +++++++------- .../src/components/more-menu/index.js | 2 +- .../header/post-publish-button-or-toggle.js | 2 +- packages/edit-post/src/plugins/index.js | 2 +- .../src/components/global-styles/screen-css.js | 2 +- .../components/header-edit-mode/more-menu/index.js | 2 +- .../src/components/welcome-guide/styles.js | 2 +- .../edit-widgets/src/components/more-menu/index.js | 2 +- packages/editor/src/components/post-url/index.js | 2 +- packages/scripts/CHANGELOG.md | 2 +- packages/scripts/README.md | 2 +- readme.txt | 4 ++-- 23 files changed, 31 insertions(+), 31 deletions(-) diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 02165e02a7f95..cc6b8e4d61351 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -9,4 +9,4 @@ Welcome to Gutenberg, a WordPress project. We hope you join us in creating the f * Join us on Slack for real-time communication, it is where maintainers coordinate around the project. To get started using Slack, see: https://make.wordpress.org/chat/ -* For general WordPress support with the core editor, see the [WordPress.org support forums](https://wordpress.org/support/) — it is highly active and well maintained. +* For general WordPress support with the core editor, see the [WordPress.org support forums](https://wordpress.org/support/forums/) — it is highly active and well maintained. diff --git a/README.md b/README.md index 126368cb20774..8ac17b8574c52 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Get hands on: check out the [block editor live demo](https://wordpress.org/guten - **Download:** To use the latest release of the Gutenberg plugin on your WordPress site: install from the plugins page in wp-admin, or [download from the WordPress.org plugins repository](https://wordpress.org/plugins/gutenberg/). -- **User Documentation:** See the [WordPress Editor documentation](https://wordpress.org/support/article/wordpress-editor/) for detailed docs on using the editor as an author creating posts and pages. +- **User Documentation:** See the [WordPress Editor documentation](https://wordpress.org/documentation/article/wordpress-block-editor/) for detailed docs on using the editor as an author creating posts and pages. - **User Support:** If you have run into an issue, you should check the [Support Forums first](https://wordpress.org/support/forums/). The forums are a great place to get help. If you have a bug to report, please [submit it to the Gutenberg repository](https://github.com/wordpress/gutenberg/issues). Please search prior to creating a new bug to confirm its not a duplicate. @@ -43,7 +43,7 @@ Review the [Create a Block tutorial](/docs/getting-started/create-block/README.m Gutenberg is an open-source project and welcomes all contributors from code to design, and from documentation to triage. The project is built by many contributors and volunteers and we'd love your help building it. -See the [Contributors Handbook](https://developer.wordpress.org/block-editor/contributors/) for all the details on how you can contribute. +See the [Contributors Handbook](https://developer.wordpress.org/block-editor/contributors/) for all the details on how you can contribute. To get up and running quickly with **code contribution** see [Getting Started With Code Contribution](/docs/contributors/code/getting-started-with-code-contribution.md). Also check out the other resources available on the [Code Contributions](/docs/contributors/code/README.md) page. diff --git a/docs/README.md b/docs/README.md index 49e562031f9e5..2a4c797336acf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,7 +20,7 @@ The Editor offers rich new value to users by offering visual, drag-and-drop crea ### Create pages and posts with the block editor -In the Block Editor Handbook, our tutorials will be development-focussed. However, it helps if you have some experience using the block editor the way an end-user would first. If you have no experience building with the block editor yet, we recommend you [learn to use the block editor](https://wordpress.org/support/article/wordpress-editor/) to create posts and pages. +In the Block Editor Handbook, our tutorials will be development-focussed. However, it helps if you have some experience using the block editor the way an end-user would first. If you have no experience building with the block editor yet, we recommend you [learn to use the block editor](https://wordpress.org/documentation/article/wordpress-block-editor/) to create posts and pages. ### Create a Block Tutorial diff --git a/docs/contributors/code/getting-started-with-code-contribution.md b/docs/contributors/code/getting-started-with-code-contribution.md index b4bc1275cf1ea..ab691fbcd68af 100644 --- a/docs/contributors/code/getting-started-with-code-contribution.md +++ b/docs/contributors/code/getting-started-with-code-contribution.md @@ -126,7 +126,7 @@ Port: {MYSQL_PORT_NUMBER} **Please note**: the MySQL port number will change each time `wp-env` restarts. If you find you can no longer access your database, simply repeat the steps above to find the new port number and restore your connection. -**Tip**: [Sequel Ace](https://sequel-ace.com/) is a useful GUI tool for accessing a MySQL database. Other tools are available and documented in this [article on accessing the WordPress database](https://wordpress.org/support/article/creating-database-for-wordpress/). +**Tip**: [Sequel Ace](https://sequel-ace.com/) is a useful GUI tool for accessing a MySQL database. Other tools are available and documented in this [article on accessing the WordPress database](https://wordpress.org/documentation/article/creating-database-for-wordpress/). #### Troubleshooting diff --git a/docs/contributors/documentation/README.md b/docs/contributors/documentation/README.md index f06abf9d0de7c..fbb7bf5bda903 100644 --- a/docs/contributors/documentation/README.md +++ b/docs/contributors/documentation/README.md @@ -14,7 +14,7 @@ The Gutenberg project uses GitHub for managing code and tracking issues. The mai There are two major sets of documentation for the Gutenberg project: -1. [User documentation](https://wordpress.org/support/article/wordpress-editor/) is information on how to use the Editor as an author publishing posts. For contributing to user docs, follow the docs blog, or ask in the #docs Slack channel, to understand the current priorities. +1. [User documentation](https://wordpress.org/documentation/article/wordpress-block-editor/) is information on how to use the Editor as an author publishing posts. For contributing to user docs, follow the docs blog, or ask in the #docs Slack channel, to understand the current priorities. 2. [Block editor handbook](https://developer.wordpress.org/block-editor/) is everything related to the Gutenberg project including: developing, extending, and—what you are reading right now—contributing specific to Gutenberg. The rest of this document covers contributing to the block editor handbook. diff --git a/docs/how-to-guides/propagating-updates.md b/docs/how-to-guides/propagating-updates.md index 3bb281fe6fdfe..ae5cb5f3b2a9a 100644 --- a/docs/how-to-guides/propagating-updates.md +++ b/docs/how-to-guides/propagating-updates.md @@ -55,7 +55,7 @@ Likewise, it is generally poor practice to delete template parts in theme update ### Resources -- [Comparing Patterns, Template Parts, and Reusable Blocks](https://wordpress.org/support/article/comparing-patterns-template-parts-and-reusable-blocks/) +- [Comparing Patterns, Template Parts, and Reusable Blocks](https://wordpress.org/documentation/article/comparing-patterns-template-parts-and-reusable-blocks/) - [Block deprecation](https://developer.wordpress.org/block-editor/reference-guides/block-api/block-deprecation/) - [Create Block tool](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/) diff --git a/docs/how-to-guides/themes/theme-json.md b/docs/how-to-guides/themes/theme-json.md index efd4820b1adf5..ba0e921109d75 100644 --- a/docs/how-to-guides/themes/theme-json.md +++ b/docs/how-to-guides/themes/theme-json.md @@ -1322,4 +1322,4 @@ The value defined for the root `styles.spacing.blockGap` style is also output as ### Why does it take so long to update the styles in the browser? -When you are actively developing with theme.json you may notice it takes 30+ seconds for your changes to show up in the browser, this is because `theme.json` is cached. To remove this caching issue, set either [`WP_DEBUG`](https://wordpress.org/support/article/debugging-in-wordpress/#wp_debug) or [`SCRIPT_DEBUG`](https://wordpress.org/support/article/debugging-in-wordpress/#script_debug) to 'true' in your [`wp-config.php`](https://wordpress.org/support/article/editing-wp-config-php/). This tells WordPress to skip the cache and always use fresh data. +When you are actively developing with theme.json you may notice it takes 30+ seconds for your changes to show up in the browser, this is because `theme.json` is cached. To remove this caching issue, set either [`WP_DEBUG`](https://wordpress.org/documentation/article/debugging-in-wordpress/#wp_debug) or [`SCRIPT_DEBUG`](https://wordpress.org/documentation/article/debugging-in-wordpress/#script_debug) to 'true' in your [`wp-config.php`](https://wordpress.org/documentation/article/editing-wp-config-php/). This tells WordPress to skip the cache and always use fresh data. diff --git a/packages/block-editor/src/components/date-format-picker/index.js b/packages/block-editor/src/components/date-format-picker/index.js index 8ee6fcd5bde44..82a7b4cf760fc 100644 --- a/packages/block-editor/src/components/date-format-picker/index.js +++ b/packages/block-editor/src/components/date-format-picker/index.js @@ -142,7 +142,7 @@ function NonDefaultControls( { format, onChange } ) { Link: ( ), diff --git a/packages/block-editor/src/hooks/anchor.js b/packages/block-editor/src/hooks/anchor.js index 65e227ab107eb..c8f7998afb57d 100644 --- a/packages/block-editor/src/hooks/anchor.js +++ b/packages/block-editor/src/hooks/anchor.js @@ -80,7 +80,7 @@ export const withInspectorControl = createHigherOrderComponent( { isWeb && ( { __( 'Learn more about anchors' ) } diff --git a/packages/block-library/src/embed/embed-link-settings.native.js b/packages/block-library/src/embed/embed-link-settings.native.js index dcacde56aa05e..ad4152c2fe19a 100644 --- a/packages/block-library/src/embed/embed-link-settings.native.js +++ b/packages/block-library/src/embed/embed-link-settings.native.js @@ -39,7 +39,7 @@ const EmbedLinkSettings = ( { label: ( diff --git a/packages/block-library/src/embed/embed-placeholder.js b/packages/block-library/src/embed/embed-placeholder.js index e3ffb5ac02845..5b9191c3446a7 100644 --- a/packages/block-library/src/embed/embed-placeholder.js +++ b/packages/block-library/src/embed/embed-placeholder.js @@ -40,7 +40,7 @@ const EmbedPlaceholder = ( {
{ __( 'Learn more about embeds' ) } diff --git a/packages/create-block/README.md b/packages/create-block/README.md index d6e77b9576388..c90e4722de7b7 100644 --- a/packages/create-block/README.md +++ b/packages/create-block/README.md @@ -8,7 +8,7 @@ _It is largely inspired by [create-react-app](https://create-react-app.dev/docs/ > _Learn more about the [Block API at the Gutenberg HandBook](https://developer.wordpress.org/block-editor/developers/block-api/block-registration/)._ -## Table of Contents +## Table of Contents - [Quick start](#quick-start) - [Usage](#usage) @@ -28,7 +28,7 @@ $ cd todo-list $ npm start ``` -The `slug` provided (`todo-list` in the example) defines the folder name for the scaffolded plugin and the internal block name. The WordPress plugin generated must [be installed manually](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation). +The `slug` provided (`todo-list` in the example) defines the folder name for the scaffolded plugin and the internal block name. The WordPress plugin generated must [be installed manually](https://wordpress.org/documentation/article/manage-plugins/#manual-plugin-installation). _(requires `node` version `14.0.0` or above, and `npm` version `6.14.4` or above)_ @@ -57,12 +57,12 @@ When no `slug` is provided, the script will run in interactive mode and will sta ### `slug` -The use of `slug` is optional. +The use of `slug` is optional. When provided it triggers the _quick mode_, where this `slug` is used: - as the block slug (required for its identification) - as the output location (folder name) for scaffolded files -- as the name of the WordPress plugin. +- as the name of the WordPress plugin. The rest of the configuration is set to all default values unless overridden with some options listed below. @@ -123,7 +123,7 @@ $ npx @wordpress/create-block --no-plugin ``` #### `--wp-env` -With this argument, the `create-block` package will add to the generated plugin the configuration and the script to run [`wp-env` package](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) within the plugin. This will allow you to easily set up a local WordPress environment (via Docker) for building and testing the generated plugin. +With this argument, the `create-block` package will add to the generated plugin the configuration and the script to run [`wp-env` package](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) within the plugin. This will allow you to easily set up a local WordPress environment (via Docker) for building and testing the generated plugin. ```bash $ npx @wordpress/create-block --wp-env @@ -131,9 +131,9 @@ $ npx @wordpress/create-block --wp-env ## Available commands in the scaffolded project -The plugin folder created when executing this command, is a node package with a modern build setup that requires no configuration. +The plugin folder created when executing this command, is a node package with a modern build setup that requires no configuration. -A set of scripts is available from inside that folder (provided by the `scripts` package) to make your work easier. [Click here](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#available-scripts) for a full description of these commands. +A set of scripts is available from inside that folder (provided by the `scripts` package) to make your work easier. [Click here](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#available-scripts) for a full description of these commands. _Note: You don’t need to install or configure tools like [webpack](https://webpack.js.org), [Babel](https://babeljs.io) or [ESLint](https://eslint.org) yourself. They are preconfigured and hidden so that you can focus on coding._ diff --git a/packages/customize-widgets/src/components/more-menu/index.js b/packages/customize-widgets/src/components/more-menu/index.js index f2384d8073b9c..9a276976dc1fd 100644 --- a/packages/customize-widgets/src/components/more-menu/index.js +++ b/packages/customize-widgets/src/components/more-menu/index.js @@ -72,7 +72,7 @@ export default function MoreMenu() { role="menuitem" icon={ external } href={ __( - 'https://wordpress.org/support/article/block-based-widgets-editor/' + 'https://wordpress.org/documentation/article/block-based-widgets-editor/' ) } target="_blank" rel="noopener noreferrer" diff --git a/packages/edit-post/src/components/header/post-publish-button-or-toggle.js b/packages/edit-post/src/components/header/post-publish-button-or-toggle.js index 837369293acbc..92f250ef2c5c3 100644 --- a/packages/edit-post/src/components/header/post-publish-button-or-toggle.js +++ b/packages/edit-post/src/components/header/post-publish-button-or-toggle.js @@ -32,7 +32,7 @@ export function PostPublishButtonOrToggle( { * Conditions to show a BUTTON (publish directly) or a TOGGLE (open publish sidebar): * * 1) We want to show a BUTTON when the post status is at the _final stage_ - * for a particular role (see https://wordpress.org/support/article/post-status/): + * for a particular role (see https://wordpress.org/documentation/article/post-status/): * * - is published * - is scheduled to be published diff --git a/packages/edit-post/src/plugins/index.js b/packages/edit-post/src/plugins/index.js index 94a5d4c98396c..b065f618912be 100644 --- a/packages/edit-post/src/plugins/index.js +++ b/packages/edit-post/src/plugins/index.js @@ -39,7 +39,7 @@ registerPlugin( 'edit-post', { role="menuitem" icon={ external } href={ __( - 'https://wordpress.org/support/article/wordpress-editor/' + 'https://wordpress.org/documentation/article/wordpress-block-editor/' ) } target="_blank" rel="noopener noreferrer" diff --git a/packages/edit-site/src/components/global-styles/screen-css.js b/packages/edit-site/src/components/global-styles/screen-css.js index c2f1ebfdf7ba7..779c64c86c4f5 100644 --- a/packages/edit-site/src/components/global-styles/screen-css.js +++ b/packages/edit-site/src/components/global-styles/screen-css.js @@ -38,7 +38,7 @@ function ScreenCSS( { name } ) { <> { description } { __( 'Learn more about CSS' ) } diff --git a/packages/edit-site/src/components/header-edit-mode/more-menu/index.js b/packages/edit-site/src/components/header-edit-mode/more-menu/index.js index 91182c2a2629e..a7c9ea977db17 100644 --- a/packages/edit-site/src/components/header-edit-mode/more-menu/index.js +++ b/packages/edit-site/src/components/header-edit-mode/more-menu/index.js @@ -93,7 +93,7 @@ export default function MoreMenu( { showIconLabels } ) { icon={ external } role="menuitem" href={ __( - 'https://wordpress.org/support/article/site-editor/' + 'https://wordpress.org/documentation/article/site-editor/' ) } target="_blank" rel="noopener noreferrer" diff --git a/packages/edit-site/src/components/welcome-guide/styles.js b/packages/edit-site/src/components/welcome-guide/styles.js index 47adb44fa5dfe..6cc664c6373fa 100644 --- a/packages/edit-site/src/components/welcome-guide/styles.js +++ b/packages/edit-site/src/components/welcome-guide/styles.js @@ -119,7 +119,7 @@ export default function WelcomeGuideStyles() { ) } { __( diff --git a/packages/edit-widgets/src/components/more-menu/index.js b/packages/edit-widgets/src/components/more-menu/index.js index ee13c959a7a57..bb3e01bd19e26 100644 --- a/packages/edit-widgets/src/components/more-menu/index.js +++ b/packages/edit-widgets/src/components/more-menu/index.js @@ -73,7 +73,7 @@ export default function MoreMenu() { role="menuitem" icon={ external } href={ __( - 'https://wordpress.org/support/article/block-based-widgets-editor/' + 'https://wordpress.org/documentation/article/block-based-widgets-editor/' ) } target="_blank" rel="noopener noreferrer" diff --git a/packages/editor/src/components/post-url/index.js b/packages/editor/src/components/post-url/index.js index a47ae4f455858..6c58a707ca874 100644 --- a/packages/editor/src/components/post-url/index.js +++ b/packages/editor/src/components/post-url/index.js @@ -61,7 +61,7 @@ export default function PostURL( { onClose } ) { { __( 'The last part of the URL.' ) }{ ' ' } { __( 'Learn more.' ) } diff --git a/packages/scripts/CHANGELOG.md b/packages/scripts/CHANGELOG.md index c8ee6791b8676..d9966e0caccc4 100644 --- a/packages/scripts/CHANGELOG.md +++ b/packages/scripts/CHANGELOG.md @@ -209,7 +209,7 @@ ### New Features - Added a new `plugin-zip` command to create a zip file for a WordPress plugin ([#37687](https://github.com/WordPress/gutenberg/pull/37687)). -- Added optional support for React Fast Refresh in the `start` command. It can be activated with `--hot` CLI argument ([#28273](https://github.com/WordPress/gutenberg/pull/28273)). For now, it requires that WordPress has the [`SCRIPT_DEBUG`](https://wordpress.org/support/article/debugging-in-wordpress/#script_debug) flag enabled and the [Gutenberg](https://wordpress.org/plugins/gutenberg/) plugin installed. +- Added optional support for React Fast Refresh in the `start` command. It can be activated with `--hot` CLI argument ([#28273](https://github.com/WordPress/gutenberg/pull/28273)). For now, it requires that WordPress has the [`SCRIPT_DEBUG`](https://wordpress.org/documentation/article/debugging-in-wordpress/#script_debug) flag enabled and the [Gutenberg](https://wordpress.org/plugins/gutenberg/) plugin installed. - Automatically copy `block.json` files located in the `src` folder and its subfolders to the output folder (`build` by default) ([#37612](https://github.com/WordPress/gutenberg/pull/37612)). - Scan the `src` directory for `block.json` files to detect defined scripts to use them as entry points with the `start` and `build` commands. ([#37661](https://github.com/WordPress/gutenberg/pull/37661)). diff --git a/packages/scripts/README.md b/packages/scripts/README.md index 81b4838b15df5..1e56a3b8a96e2 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -381,7 +381,7 @@ This is how you execute the script with presented setup: This script automatically use the optimized config but sometimes you may want to specify some custom options: -- `--hot` – enables "Fast Refresh". The page will automatically reload if you make changes to the code. _For now, it requires that WordPress has the [`SCRIPT_DEBUG`](https://wordpress.org/support/article/debugging-in-wordpress/#script_debug) flag enabled and the [Gutenberg](https://wordpress.org/plugins/gutenberg/) plugin installed._ +- `--hot` – enables "Fast Refresh". The page will automatically reload if you make changes to the code. _For now, it requires that WordPress has the [`SCRIPT_DEBUG`](https://wordpress.org/documentation/article/debugging-in-wordpress/#script_debug) flag enabled and the [Gutenberg](https://wordpress.org/plugins/gutenberg/) plugin installed._ - `--webpack-bundle-analyzer` – enables visualization for the size of webpack output files with an interactive zoomable treemap. - `--webpack-copy-php` – enables copying all PHP files from the source directory ( default is `src` ) and its subfolders to the output directory. - `--webpack-devtool` – controls how source maps are generated. See options at https://webpack.js.org/configuration/devtool/#devtool. diff --git a/readme.txt b/readme.txt index 9a21c99105dcd..ef8e6420a3c89 100644 --- a/readme.txt +++ b/readme.txt @@ -31,7 +31,7 @@ For the adventurous and tech-savvy, the Gutenberg plugin gives you the latest an ### Discover More -- **User Documentation:** Review the WordPress Editor documentation for detailed instructions on using the editor as an author to create posts, pages, and more. +- **User Documentation:** Review the WordPress Editor documentation for detailed instructions on using the editor as an author to create posts, pages, and more. - **Developer Documentation:** Explore the Developer Documentation for extensive tutorials, documentation, and API references on how to extend the editor. @@ -55,7 +55,7 @@ To report a security issue, please visit the [WordPress HackerOne](https://hacke = Do I have to use the Gutenberg plugin to get access to these features? = -Not necessarily. Each version of WordPress after 5.0 has included features from the Gutenberg plugin, which are known collectively as the WordPress Editor. You are likely already benefitting from stable features! +Not necessarily. Each version of WordPress after 5.0 has included features from the Gutenberg plugin, which are known collectively as the WordPress Editor. You are likely already benefitting from stable features! But if you want cutting edge beta features, including more experimental items, you will need to use the plugin. You can read more here to help decide whether the plugin is right for you.