From f8f70ec8eb115191769bc8176e4720acf516ed3d Mon Sep 17 00:00:00 2001 From: Daryll Doyle Date: Mon, 4 Sep 2023 17:14:35 +0100 Subject: [PATCH] Update tooling information --- _includes/markdown/Tools.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/_includes/markdown/Tools.md b/_includes/markdown/Tools.md index d2571f9f..f557cb79 100644 --- a/_includes/markdown/Tools.md +++ b/_includes/markdown/Tools.md @@ -1,10 +1,10 @@ -The following are tools we use at 10up. This list will grow and change over time and is not meant to be comprehensive. Generally, we encourage or require these tools to be used in favor of other ones. Rules governing tools to be used and packaged with a client site will be much stricter than those used on internal projects. +The following are tools we use at 10up. This list is not comprehensive and will grow and change over time. Generally, we encourage engineers to use these tools in favor of others. Rules governing tools to be used and packaged with a client site will be much stricter than those used on internal projects.

Local Development Environments {% include Util/link_anchor anchor="local-development" %} {% include Util/top %}

-At 10up, we use [Docker](https://www.docker.com/) to build and interact with virtual environments that match production as closely as possible. There are many setups and configurations available, but the following setup is supported internally: +At 10up, we use [Local WP](https://localwp.com/) to build and interact with local environments. Local WP makes it easy to spin up, manage, and interact with local WordPress environments. It's available for Mac, Windows, and Linux. -* [WP Local Docker](https://10up.github.io/wp-local-docker-docs/) - An easy-to-use Docker-based local development environment for WordPress development that works on Mac, Windows, and Linux. Each environment within WP Local Docker is powered by Nginx, PHP-FPM, Memcached, and if desired, ElasticSearch. +Local WP replaces Docker and WP Local Docker as the recommended development environment at 10up.

Scaffolding {% include Util/link_anchor anchor="scaffolding" %} {% include Util/top %}

@@ -12,27 +12,23 @@ At 10up, we use [Docker](https://www.docker.com/) to build and interact with vir

Task Runners {% include Util/link_anchor anchor="task-runners" %} {% include Util/top %}

-[Grunt](http://gruntjs.com/) - Grunt is a task runner built on Node that lets you automate tasks like Sass preprocessing and JS minification. Grunt is our default task runner and has a great community of plugins and solutions we use for on company and client projects. +[10up-toolkit](https://github.com/10up/10up-toolkit/blob/develop/packages/toolkit/README.md) - 10up Toolkit is 10up’s official asset bundling tool based on Webpack 5. It comes with support for most everyday requirements within 10up projects. -[Gulp](http://gulpjs.com/) - Gulp is also a task runner build on Node that offers a similar suite of plugins and solutions to Grunt. The biggest difference is Gulp allows you direct access to the [stream](https://nodejs.org/api/stream.html) of information from your source files and allows you to modify this data directly. - -[Webpack](https://webpack.github.io/) - Webpack is a bundler for JS/CSS. It's extremely useful when building larger JavaScript applications (i.e. React.js). +[Webpack](https://webpack.github.io/) - Webpack is a bundler for JS/CSS. It’s beneficial when 10up Toolkit can’t handle a project’s requirements.

Package/Dependency Managers {% include Util/link_anchor anchor="package-managers" %} {% include Util/top %}

-[Composer](https://getcomposer.org) - We use Composer for managing PHP dependencies. Usually everything we need is bundled with WordPress, but sometimes we need external PHP libraries like "Patchwork". Composer is a great way to manage those external libraries. +[Composer](https://getcomposer.org) - We use Composer for managing PHP dependencies. When we need to pull in external PHP libraries, Composer provides an easy way to install and update those. -When a WordPress install is managed and maintained by an engineering team, and when the infrastructure supports it, plugins in a WordPress project can be easily managed using Composer. [WordPress Packagist](https://wpackagist.org/) provides a Composer repository that mirrors all public WordPress plugins and themes. +The [WordPress Packagist](https://wpackagist.org/) repository mirrors all public WordPress plugins and themes, allowing an engineering team to easily manage them using Composer.

Version Control {% include Util/link_anchor anchor="version-control" %} {% include Util/top %}

[Git](https://git-scm.com) - At 10up we use Git for version control. We encourage people to use the command line for interacting with Git. GUIs are permitted but will not be supported internally. -[SVN](https://subversion.apache.org/) - We use SVN, but only in the context of WordPress.com VIP. Again, we encourage people to use the command line as we do not support GUIs internally. -

Command Line Tools {% include Util/link_anchor anchor="command-line" %} {% include Util/top %}

-[WP-CLI](https://wp-cli.org) - A command line interface for WordPress. This is an extremely powerful tool that allows us to do imports, exports, run custom scripts, and more via the command line. Often this is the only way we can affect a large database (WordPress.com VIP or WP Engine). This tool is installed by default on [WP Local Docker](https://10up.github.io/wp-local-docker-docs/). +[WP-CLI](https://wp-cli.org) - A command line interface for WordPress. This extremely powerful tool allows us to do imports, exports, run custom scripts, and more via the command line. Often, this is the only way we can affect a large database (WordPress.com VIP or WP Engine). This tool comes bundled with [Local WP](https://localwp.com/).

Accessibility Testing {% include Util/link_anchor anchor="a11y-testing" %} {% include Util/top %}