From 65258a077e4899ee4933c79077108f56f8b5ce6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Wrede?= Date: Wed, 5 Aug 2020 00:17:39 +0200 Subject: [PATCH] Fix typos in docs (#24361) --- .../designers/design-resources.md | 6 +++--- .../developers/filters/block-filters.md | 2 +- .../developers/platform/README.md | 2 +- .../developers/slotfills/main-dashboard-button.md | 12 ++++++------ .../developers/themes/theme-support.md | 4 ++-- .../block-tutorial/nested-blocks-inner-blocks.md | 2 +- .../developers/tutorials/create-block/readme.md | 4 ++-- .../developers/tutorials/create-block/wp-plugin.md | 2 +- .../developers/tutorials/devenv/readme.md | 4 ++-- .../tutorials/metabox/meta-block-1-intro.md | 2 +- .../developers/tutorials/readme.md | 2 +- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/designers-developers/designers/design-resources.md b/docs/designers-developers/designers/design-resources.md index eaa82d16356c3..a4f01f98b18a8 100644 --- a/docs/designers-developers/designers/design-resources.md +++ b/docs/designers-developers/designers/design-resources.md @@ -1,7 +1,7 @@ # Resources ## Figma -The [WordPress Design team](https://make.wordpress.org/design/) uses [Figma](https://www.figma.com/) to collaborate and share work. If you'd like to contribute, join the [#design channel](https://app.slack.com/client/T024MFP4J/C02S78ZAL) in [Slack](https://make.wordpress.org/chat/) and ask the team to set you up with a free Figma account. This will give you access to a helpful library of components used in WordPress. They are stable, fully supported, up to date, and ready for use in designs and prototypes. +The [WordPress Design team](https://make.wordpress.org/design/) uses [Figma](https://www.figma.com/) to collaborate and share work. If you'd like to contribute, join the [#design channel](https://app.slack.com/client/T024MFP4J/C02S78ZAL) in [Slack](https://make.wordpress.org/chat/) and ask the team to set you up with a free Figma account. This will give you access to a helpful library of components used in WordPress. They are stable, fully supported, up to date, and ready for use in designs and prototypes. ### How to contribute @@ -35,13 +35,13 @@ The [WordPress Design team](https://make.wordpress.org/design/) uses [Figma](htt ![How to turn on Figma libraries gif](https://wordpress.org/gutenberg/files/2019/08/figma-howtoturnonlibraries.gif) -1. Click the **Team Library** icon in the **Assets** Panel: +1. Click the **Team Library** icon in the **Assets** Panel: ![Hovering over the team library icon](https://wordpress.org/gutenberg/files/2019/08/figma-turn-on-libraries-e1564770916643.png) 2. The **Library** modal will open and allow you to view a list of available libraries. Toggle to _Enable_ or _Disable_ a specific library: -![Switching on the WordPress components libray in Figma](https://wordpress.org/gutenberg/files/2019/08/figma-libraries-e1564770879415.png) +![Switching on the WordPress components library in Figma](https://wordpress.org/gutenberg/files/2019/08/figma-libraries-e1564770879415.png) **How to refine or contribute to the WordPress components React library _(Coming soon)_** diff --git a/docs/designers-developers/developers/filters/block-filters.md b/docs/designers-developers/developers/filters/block-filters.md index 929b8db33f10f..81e4fd9d1a91a 100644 --- a/docs/designers-developers/developers/filters/block-filters.md +++ b/docs/designers-developers/developers/filters/block-filters.md @@ -178,7 +178,7 @@ wp.hooks.addFilter( ); ``` -_Note:_ A [block validation](/docs/designers-developers/developers/block-api/block-edit-save.md#validation) error will occur if this filter modifies existing content the next time the post is edited. The editor verifies that the content stored in the post matches the content ouput by the `save()` function. +_Note:_ A [block validation](/docs/designers-developers/developers/block-api/block-edit-save.md#validation) error will occur if this filter modifies existing content the next time the post is edited. The editor verifies that the content stored in the post matches the content output by the `save()` function. To avoid this validation error, use `render_block` server-side to modify existing post content instead of this filter. See [render_block documentation](https://developer.wordpress.org/reference/hooks/render_block/). diff --git a/docs/designers-developers/developers/platform/README.md b/docs/designers-developers/developers/platform/README.md index 5bd14bbb2bd18..e7ac946000f95 100644 --- a/docs/designers-developers/developers/platform/README.md +++ b/docs/designers-developers/developers/platform/README.md @@ -35,7 +35,7 @@ The [wp-scripts package](https://developer.wordpress.org/block-editor/packages/p Here is a quick example, on how to use wp-scripts in your project. -Install the depenency: +Install the dependency: ```bash npm install --save-dev @wordpress/scripts diff --git a/docs/designers-developers/developers/slotfills/main-dashboard-button.md b/docs/designers-developers/developers/slotfills/main-dashboard-button.md index 63af26b62c26e..3a10665f21ad8 100644 --- a/docs/designers-developers/developers/slotfills/main-dashboard-button.md +++ b/docs/designers-developers/developers/slotfills/main-dashboard-button.md @@ -7,7 +7,7 @@ the editor in fullscreen mode. ```js import { registerPlugin } from '@wordpress/plugins'; -import { +import { __experimentalMainDashboardButton as MainDashboardButton, } from '@wordpress/interface'; @@ -28,17 +28,17 @@ in the following way: ```js import { registerPlugin } from '@wordpress/plugins'; import { - __experimentalFullscrenModeClose as FullscrenModeClose, + __experimentalFullscreenModeClose as FullscreenModeClose, } from '@wordpress/edit-site'; -import { +import { __experimentalMainDashboardButton as MainDashboardButton, } from '@wordpress/interface'; -import { close } from '@wordpress/icons'; - +import { close } from '@wordpress/icons'; + const MainDashboardButtonIconTest = () => ( - + ); diff --git a/docs/designers-developers/developers/themes/theme-support.md b/docs/designers-developers/developers/themes/theme-support.md index 9e42c7e1774d0..d6a894fc0eeaa 100644 --- a/docs/designers-developers/developers/themes/theme-support.md +++ b/docs/designers-developers/developers/themes/theme-support.md @@ -12,7 +12,7 @@ There are a few new concepts to consider when building themes: - **Block Tools** - Themes can opt-in to several block tools like line height, custom units. - **Core Block Patterns** - Themes can opt-out of the default block patterns. -By default, blocks provide their styles to enable basic support for blocks in themes without any change. They also [provide opt-in opinonated styles](#default-block-styles). Themes can add/override these styles, or they can provide no styles at all, and rely fully on what the blocks provide. +By default, blocks provide their styles to enable basic support for blocks in themes without any change. They also [provide opt-in opinionated styles](#default-block-styles). Themes can add/override these styles, or they can provide no styles at all, and rely fully on what the blocks provide. Some advanced block features require opt-in support in the theme itself as it's difficult for the block to provide these styles, they may require some architecting of the theme itself, in order to work well. @@ -407,7 +407,7 @@ add_theme_support('experimental-link-color'); If a theme opts in, it should [define default link colors](https://developer.wordpress.org/block-editor/developers/themes/theme-json/#color-properties) in `experimental-theme.json` (or in its theme styles if no `experimental-theme.json` is present). For example: ```css -{ +{ "global": { "styles": { "color": { diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md b/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md index cc538c8ccde85..ed156a0eb7277 100644 --- a/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md +++ b/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md @@ -135,7 +135,7 @@ const MY_TEMPLATE = [ ``` {% end %} -Use the `templateLock` property to lock down the template. Using `all` locks the template complete, no changes can be made. Using `insert` prevents additional blocks to be inserted, but existing blocks can be reorderd. See [templateLock documentation](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inner-blocks/README.md#templatelock) for additional information. +Use the `templateLock` property to lock down the template. Using `all` locks the template complete, no changes can be made. Using `insert` prevents additional blocks to be inserted, but existing blocks can be reordered. See [templateLock documentation](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inner-blocks/README.md#templatelock) for additional information. ### Post Template diff --git a/docs/designers-developers/developers/tutorials/create-block/readme.md b/docs/designers-developers/developers/tutorials/create-block/readme.md index 0788648a2cc7e..e9d06866260f7 100644 --- a/docs/designers-developers/developers/tutorials/create-block/readme.md +++ b/docs/designers-developers/developers/tutorials/create-block/readme.md @@ -4,9 +4,9 @@ Let's get you started creating your first block for the WordPress Block Editor. The tutorial includes setting up your development environment, tools, and getting comfortable with the new development model. If you are already comfortable, try the quick start below, otherwise step through whatever part of the tutorial you need. -## Prerequisities +## Prerequisites -The first thing you need is a development enviornment and tools. This includes setting up your WordPress environment, Node, NPM, and your code editor. If you need help, see the [setting up your development environment documentation](/docs/designers-developers/developers/tutorials/devenv/readme.md). +The first thing you need is a development environment and tools. This includes setting up your WordPress environment, Node, NPM, and your code editor. If you need help, see the [setting up your development environment documentation](/docs/designers-developers/developers/tutorials/devenv/readme.md). ## Quick Start diff --git a/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md b/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md index 910d4c6f54262..8264b77ca30e1 100644 --- a/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md +++ b/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md @@ -149,7 +149,7 @@ With the above in place, create a new post to load the editor and check the you It is a good skill to learn and get comfortable using the web console. This is where JavaScript errors are shown and a nice way to test out snippets of JavaScript. See [Firefox Developer Tools documentation](https://developer.mozilla.org/en-US/docs/Tools). -To open the developer tools in Firefox, use the menu selecting Web Developer : Toggle Tools, on Chrome, select More Tools -> Developers Tools. For both browers, the keyboard shortcut on Windows is Ctrl+Shift+I, or on Mac Cmd+Shift+I. On Windows & Linux, the F12 key also works. You can then click Console to view logs. +To open the developer tools in Firefox, use the menu selecting Web Developer : Toggle Tools, on Chrome, select More Tools -> Developers Tools. For both browsers, the keyboard shortcut on Windows is Ctrl+Shift+I, or on Mac Cmd+Shift+I. On Windows & Linux, the F12 key also works. You can then click Console to view logs. Try running `npm run start` that will start the watch process for automatic rebuilds. If you then make an update to `src/index.js` file, you will see the build run, and if you reload the WordPress editor you'll see the change. diff --git a/docs/designers-developers/developers/tutorials/devenv/readme.md b/docs/designers-developers/developers/tutorials/devenv/readme.md index 37cf0fabdf5be..c71d4080eb57b 100644 --- a/docs/designers-developers/developers/tutorials/devenv/readme.md +++ b/docs/designers-developers/developers/tutorials/devenv/readme.md @@ -16,7 +16,7 @@ The tools are used to convert the JavaScript we are going to write into a format For Mac and Linux, it is recommended to use the [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm). Using `nvm` to install node allows installing specific versions, plus installs locally in your home directory and avoids any global permission issues. -For Windows, or alternative installs, you can [download a Nodejs installer](https://nodejs.org/en/download/) directly from the main Node.js website, the long term support (LTS) version is recommeneded. Installers are available for Windows and Mac, and binaries available for Linux. See Node.js site for additional installation methods. +For Windows, or alternative installs, you can [download a Nodejs installer](https://nodejs.org/en/download/) directly from the main Node.js website, the long term support (LTS) version is recommended. Installers are available for Windows and Mac, and binaries available for Linux. See Node.js site for additional installation methods. Here are the quick instructions to install using nvm, see the [full installation instructions](https://github.com/nvm-sh/nvm#installing-and-updating) for additional details. @@ -108,7 +108,7 @@ A block is just a plugin, so any WordPress environment can be used for developme - [WampServer](http://www.wampserver.com/en/) or [MAMP](https://www.mamp.info/) environments, both are quite similar to Local, combining a web server, PHP, and database. However these tools are not WordPress specific, so if you are not already using them, Local might be an easier option -- Remote server - you could work on remote server that is easy to setup, since most hosts have a standard WordPress install. However, this may require additonal development time to sync to the server. +- Remote server - you could work on remote server that is easy to setup, since most hosts have a standard WordPress install. However, this may require additional development time to sync to the server. The important part is having a WordPress site installed, and know where and how to update files in the plugins directory. diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md b/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md index c89c757a92209..9e2450aba9de8 100644 --- a/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md +++ b/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md @@ -1,6 +1,6 @@ # Store Post Meta with a Block -Typically, blocks store their attribute values in the serialised block HTML. However, you can also create a block that saves its attribute values as post meta, which can be accessed programatically anywhere in your template. +Typically, blocks store their attribute values in the serialised block HTML. However, you can also create a block that saves its attribute values as post meta, which can be accessed programmatically anywhere in your template. In this short tutorial you will create one of these blocks, which will prompt a user for a single value, and save it as post meta. diff --git a/docs/designers-developers/developers/tutorials/readme.md b/docs/designers-developers/developers/tutorials/readme.md index e489b6c07c793..17c428bbb508b 100644 --- a/docs/designers-developers/developers/tutorials/readme.md +++ b/docs/designers-developers/developers/tutorials/readme.md @@ -6,7 +6,7 @@ - Beginners: The [Create a Block Tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. -- Intermediate: The [Block Tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/readme.md) covers different aspects of block developement. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. +- Intermediate: The [Block Tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. - See the [Meta Boxes Tutorial](/docs/designers-developers/developers/tutorials/metabox/readme.md) for new ways of extending the editor storing and using post meta data.