diff --git a/bin/command.php b/bin/command.php index 5f18525e..ccb8d6f7 100644 --- a/bin/command.php +++ b/bin/command.php @@ -387,66 +387,73 @@ public function gen_commands_manifest() { */ public function gen_hb_manifest() { $manifest = []; - // Top-level pages - foreach ( glob( WP_CLI_HANDBOOK_PATH . '/*.md' ) as $file ) { - $slug = basename( $file, '.md' ); - if ( 'README' === $slug ) { + + $ignored_dirs = [ + '.git', + '.github', + 'bin', + 'commands', + 'vendor', + ]; + + $files = new \RecursiveIteratorIterator( + new \RecursiveCallbackFilterIterator( + new \RecursiveDirectoryIterator( WP_CLI_HANDBOOK_PATH, \RecursiveDirectoryIterator::SKIP_DOTS ), + static function ( $file ) use ( $ignored_dirs ) { + /** @var SplFileInfo $file */ + + if ( $file->isDir() && in_array( $file->getBasename(), $ignored_dirs, true ) ) { + return false; + } + + if ( $file->isFile() && $file->getExtension() !== 'md' ) { + return false; + } + + if ( 'README.md' === $file->getBasename() ) { + return false; + } + + return true; + } + ), + \RecursiveIteratorIterator::CHILD_FIRST + ); + + foreach ( $files as $file ) { + if ( $file->isDir() ) { continue; } - $title = ''; - $contents = file_get_contents( $file ); - if ( preg_match( '/^#\s(.+)/', $contents, $matches ) ) { - $title = $matches[1]; - } - $manifest[ $slug ] = [ - 'title' => $title, - 'slug' => 'index' === $slug ? 'handbook' : $slug, - 'markdown_source' => sprintf( - 'https://github.com/wp-cli/handbook/blob/main/%s.md', - $slug - ), - 'parent' => null, - ]; - } - // Internal API pages. - foreach ( glob( WP_CLI_HANDBOOK_PATH . '/internal-api/*.md' ) as $file ) { - $slug = basename( $file, '.md' ); - $title = ''; - $contents = file_get_contents( $file ); - if ( preg_match( '/^#\s(.+)/', $contents, $matches ) ) { - $title = $matches[1]; - } - $manifest[ $slug ] = [ - 'title' => $title, - 'slug' => $slug, - 'markdown_source' => sprintf( - 'https://github.com/wp-cli/handbook/blob/main/internal-api/%s.md', - $slug - ), - 'parent' => 'internal-api', - ]; - } + $rel_path = str_replace( WP_CLI_HANDBOOK_PATH . '/', '', $file->getPathname() ); + + $path = explode( '/', $rel_path ); + array_pop( $path ); + + $parent = ! empty( $path ) ? end( $path ) : null; + + $path = implode( '/', $path ); + + $slug = $file->getBasename( '.md' ); - // Behat steps pages. - foreach ( glob( WP_CLI_HANDBOOK_PATH . '/behat-steps/*.md' ) as $file ) { - $slug = basename( $file, '.md' ); $title = ''; - $contents = file_get_contents( $file ); + $contents = file_get_contents( $file->getPathname() ); if ( preg_match( '/^#\s(.+)/', $contents, $matches ) ) { $title = $matches[1]; } $manifest[ $slug ] = [ 'title' => $title, - 'slug' => $slug, + 'slug' => 'index' === $slug ? 'handbook' : $slug, 'markdown_source' => sprintf( - 'https://github.com/wp-cli/handbook/blob/main/behat-steps/%s.md', - $slug + 'https://github.com/wp-cli/handbook/blob/main/%s', + $rel_path ), - 'parent' => 'behat-steps', + 'parent' => $parent, ]; } + ksort( $manifest ); + file_put_contents( WP_CLI_HANDBOOK_PATH . '/bin/handbook-manifest.json', json_encode( $manifest, JSON_PRETTY_PRINT ) ); WP_CLI::success( 'Generated bin/handbook-manifest.json' ); } diff --git a/bin/handbook-manifest.json b/bin/handbook-manifest.json index 08c8c027..02f1c1a2 100644 --- a/bin/handbook-manifest.json +++ b/bin/handbook-manifest.json @@ -2,182 +2,344 @@ "behat-steps": { "title": "Behat Steps", "slug": "behat-steps", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps.md", + "parent": "references" }, "bug-reports": { "title": "Bug Reports", "slug": "bug-reports", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/bug-reports.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/bug-reports.md", + "parent": "contributions" }, "code-review": { "title": "Code Review", "slug": "code-review", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/code-review.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/code-review.md", + "parent": "contributions" }, "commands-cookbook": { "title": "Commands Cookbook", "slug": "commands-cookbook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands-cookbook.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/commands-cookbook.md", + "parent": "guides" }, "committers-credo": { "title": "Committers Credo", "slug": "committers-credo", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/committers-credo.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/committers-credo.md", + "parent": "contributions" }, "common-issues": { "title": "Common Issues", "slug": "common-issues", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/common-issues.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/common-issues.md", + "parent": "guides" }, "config": { "title": "Config", "slug": "config", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/config.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/config.md", + "parent": "references" }, "contributing": { "title": "Contributing", "slug": "contributing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributing.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/contributing.md", + "parent": "contributions" + }, + "contributions": { + "title": "Contributions", + "slug": "contributions", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions.md", "parent": null }, "contributor-day": { "title": "WordCamp Contributor Day", "slug": "contributor-day", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributor-day.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/contributor-day.md", + "parent": "contributions" + }, + "doctor": { + "title": "Doctor Guides", + "slug": "doctor", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor.md", + "parent": "guides" }, "doctor-check-constant-value": { "title": "Write a check for asserting the value of a given constant", "slug": "doctor-check-constant-value", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-check-constant-value.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-check-constant-value.md", + "parent": "doctor" }, "doctor-check-file-contents": { "title": "Write a check for verifying contents of WordPress files", "slug": "doctor-check-file-contents", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-check-file-contents.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-check-file-contents.md", + "parent": "doctor" }, "doctor-check-option-value": { "title": "Write a check for asserting the value of a given option", "slug": "doctor-check-option-value", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-check-option-value.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-check-option-value.md", + "parent": "doctor" }, "doctor-check-plugin-status": { "title": "Check status of a given plugin", "slug": "doctor-check-plugin-status", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-check-plugin-status.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-check-plugin-status.md", + "parent": "doctor" }, "doctor-customize-config": { "title": "Customize doctor diagnostic checks", "slug": "doctor-customize-config", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-customize-config.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-customize-config.md", + "parent": "doctor" }, "doctor-default-checks": { "title": "Default doctor diagnostic checks", "slug": "doctor-default-checks", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-default-checks.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-default-checks.md", + "parent": "doctor" }, "doctor-write-custom-check": { "title": "Write a custom check to perform an arbitrary assertion", "slug": "doctor-write-custom-check", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor-write-custom-check.md", - "parent": null - }, - "doctor": { - "title": "Doctor Guides", - "slug": "doctor", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/doctor.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/doctor\/doctor-write-custom-check.md", + "parent": "doctor" }, "documentation-standards": { "title": "Documentation Standards", "slug": "documentation-standards", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/documentation-standards.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/documentation-standards.md", + "parent": "references" }, "external-resources": { "title": "External Resources", "slug": "external-resources", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/external-resources.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/external-resources.md", + "parent": "guides" }, "force-output-specific-locale": { "title": "Force output to a specific locale", "slug": "force-output-specific-locale", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/force-output-specific-locale.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/force-output-specific-locale.md", + "parent": "guides" + }, + "given-a-custom-wp-content-directory": { + "title": "Given a custom wp-content directory", + "slug": "given-a-custom-wp-content-directory", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-custom-wp-content-directory.md", + "parent": "behat-steps" + }, + "given-a-database": { + "title": "Given a database", + "slug": "given-a-database", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-database.md", + "parent": "behat-steps" + }, + "given-a-dependency-on-current-wp-cli": { + "title": "Given a dependency on current wp-cli", + "slug": "given-a-dependency-on-current-wp-cli", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-dependency-on-current-wp-cli.md", + "parent": "behat-steps" + }, + "given-a-downloaded-phar-with-the-same-version-version": { + "title": "Given \/^a downloaded Phar with (?:the same version|version "([^"]+)")$\/", + "slug": "given-a-downloaded-phar-with-the-same-version-version", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-downloaded-phar-with-the-same-version-version.md", + "parent": "behat-steps" + }, + "given-a-misconfigured-wp-content-dir-constant-directory": { + "title": "Given a misconfigured WP_CONTENT_DIR constant directory", + "slug": "given-a-misconfigured-wp-content-dir-constant-directory", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-misconfigured-wp-content-dir-constant-directory.md", + "parent": "behat-steps" + }, + "given-a-new-phar-with-the-same-version-version": { + "title": "Given \/^a new Phar with (?:the same version|version "([^"]+)")$\/", + "slug": "given-a-new-phar-with-the-same-version-version", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-new-phar-with-the-same-version-version.md", + "parent": "behat-steps" + }, + "given-a-php-built-in-web-server": { + "title": "Given a PHP built-in web server", + "slug": "given-a-php-built-in-web-server", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-php-built-in-web-server.md", + "parent": "behat-steps" + }, + "given-a-php-built-in-web-server-to-serve-subdir": { + "title": "Given a PHP built-in web server to serve :subdir", + "slug": "given-a-php-built-in-web-server-to-serve-subdir", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-php-built-in-web-server-to-serve-subdir.md", + "parent": "behat-steps" + }, + "given-a-wp-installation": { + "title": "Given a WP install(ation)", + "slug": "given-a-wp-installation", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation.md", + "parent": "behat-steps" + }, + "given-a-wp-installation-in-subdir": { + "title": "Given a WP install(ation) in :subdir", + "slug": "given-a-wp-installation-in-subdir", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-in-subdir.md", + "parent": "behat-steps" + }, + "given-a-wp-installation-with-composer": { + "title": "Given a WP install(ation) with Composer", + "slug": "given-a-wp-installation-with-composer", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-with-composer.md", + "parent": "behat-steps" + }, + "given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory": { + "title": "Given a WP install(ation) with Composer and a custom vendor directory :vendor_directory", + "slug": "given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md", + "parent": "behat-steps" + }, + "given-a-wp-multisite-subdirectory-subdomaininstall-installation": { + "title": "Given \/^a WP multisite (subdirectory|subdomain)?\\s?(install|installation)$\/", + "slug": "given-a-wp-multisite-subdirectory-subdomaininstall-installation", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md", + "parent": "behat-steps" + }, + "given-an-empty-cache": { + "title": "Given an empty cache", + "slug": "given-an-empty-cache", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-empty-cache.md", + "parent": "behat-steps" + }, + "given-an-empty-directory": { + "title": "Given an empty directory", + "slug": "given-an-empty-directory", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-empty-directory.md", + "parent": "behat-steps" + }, + "given-an-empty-non-existent-directory": { + "title": "Given \/^an? (empty|non-existent) ([^\\s]+) directory$\/", + "slug": "given-an-empty-non-existent-directory", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-empty-non-existent-directory.md", + "parent": "behat-steps" + }, + "given-an-file-cache-file": { + "title": "Given \/^an? ([^\\s]+) (file|cache file):$\/", + "slug": "given-an-file-cache-file", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-file-cache-file.md", + "parent": "behat-steps" + }, + "given-download": { + "title": "Given download:", + "slug": "given-download", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-download.md", + "parent": "behat-steps" + }, + "given-replaced-with-in-the-file": { + "title": "Given \/^"([^"]+)" replaced with "([^"]+)" in the ([^\\s]+) file$\/", + "slug": "given-replaced-with-in-the-file", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-replaced-with-in-the-file.md", + "parent": "behat-steps" + }, + "given-save-stdout-stderr-as": { + "title": "Given \/^save (STDOUT|STDERR) ([\\'].+[^\\'])?\\s?as \\{(\\w+)\\}$\/", + "slug": "given-save-stdout-stderr-as", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-save-stdout-stderr-as.md", + "parent": "behat-steps" + }, + "given-save-the-file-as": { + "title": "Given \/^save the (.+) file ([\\'].+[^\\'])?as \\{(\\w+)\\}$\/", + "slug": "given-save-the-file-as", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-save-the-file-as.md", + "parent": "behat-steps" + }, + "given-that-http-requests-to-will-respond-with": { + "title": "Given \/^that HTTP requests to (.*?) will respond with:$\/", + "slug": "given-that-http-requests-to-will-respond-with", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-that-http-requests-to-will-respond-with.md", + "parent": "behat-steps" + }, + "given-these-installed-and-active-plugins": { + "title": "Given these installed and active plugins:", + "slug": "given-these-installed-and-active-plugins", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-these-installed-and-active-plugins.md", + "parent": "behat-steps" + }, + "given-wp-config-php": { + "title": "Given wp-config.php", + "slug": "given-wp-config-php", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-wp-config-php.md", + "parent": "behat-steps" + }, + "given-wp-files": { + "title": "Given WP files", + "slug": "given-wp-files", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-wp-files.md", + "parent": "behat-steps" }, "governance": { "title": "Governance", "slug": "governance", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/governance.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/governance.md", + "parent": "contributions" + }, + "guides": { + "title": "Guides", + "slug": "guides", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides.md", "parent": null }, "hack-day": { "title": "WP-CLI Hack Day", "slug": "hack-day", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/hack-day.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/hack-day.md", + "parent": "contributions" }, "hosting-companies": { "title": "Hosting Companies", "slug": "hosting-companies", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/hosting-companies.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/hosting-companies.md", + "parent": "references" + }, + "how-to": { + "title": "How to WP-CLI", + "slug": "how-to", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to.md", "parent": null }, "how-to-create-custom-plugins": { - "title": "How to create a custom plugin:", + "title": "How to create a custom plugin", "slug": "how-to-create-custom-plugins", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to-create-custom-plugins.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to\/how-to-create-custom-plugins.md", + "parent": "how-to" }, "how-to-install": { "title": "How to install WordPress", "slug": "how-to-install", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to-install.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to\/how-to-install.md", + "parent": "how-to" }, "how-to-maintenance-mode": { "title": "How to put the site in maintenance mode", "slug": "how-to-maintenance-mode", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to-maintenance-mode.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to\/how-to-maintenance-mode.md", + "parent": "how-to" }, "how-to-start-webserver": { "title": "How to start the webserver", "slug": "how-to-start-webserver", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to-start-webserver.md", - "parent": null - }, - "how-to": { - "title": "How to WP-CLI", - "slug": "how-to", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to\/how-to-start-webserver.md", + "parent": "how-to" }, "identify-plugin-theme-conflict": { "title": "Identify a Plugin or Theme Conflict", "slug": "identify-plugin-theme-conflict", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/identify-plugin-theme-conflict.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to\/identify-plugin-theme-conflict.md", + "parent": "how-to" }, "implementation-details": { "title": "Implementation Details", "slug": "implementation-details", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/implementation-details.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/implementation-details.md", + "parent": "contributions" }, "index": { "title": "Handbook", @@ -188,613 +350,469 @@ "installing": { "title": "Installing", "slug": "installing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/installing.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/installing.md", + "parent": "guides" }, "internal-api": { "title": "Internal API", "slug": "internal-api", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api.md", + "parent": "references" }, "philosophy": { "title": "Philosophy", "slug": "philosophy", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/philosophy.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/philosophy.md", + "parent": "contributions" }, "plugin-unit-tests": { "title": "Plugin Integration Tests", "slug": "plugin-unit-tests", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/plugin-unit-tests.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/how-to\/plugin-unit-tests.md", + "parent": "how-to" }, "pull-requests": { "title": "Pull Requests", "slug": "pull-requests", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/pull-requests.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/pull-requests.md", + "parent": "contributions" }, "quick-start": { "title": "Quick Start", "slug": "quick-start", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/quick-start.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/quick-start.md", + "parent": "guides" + }, + "references": { + "title": "References", + "slug": "references", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references.md", "parent": null }, "release-checklist": { "title": "Release Checklist", "slug": "release-checklist", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/release-checklist.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/release-checklist.md", + "parent": "contributions" }, "repository-management": { "title": "Repository Management", "slug": "repository-management", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/repository-management.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/repository-management.md", + "parent": "contributions" }, "roadmap": { "title": "Roadmap", "slug": "roadmap", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/roadmap.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/contributions\/roadmap.md", + "parent": "contributions" }, "running-commands-remotely": { "title": "Running Commands Remotely", "slug": "running-commands-remotely", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/running-commands-remotely.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/running-commands-remotely.md", + "parent": "guides" }, "sharing-wp-cli-packages": { "title": "Sharing WP-CLI Packages", "slug": "sharing-wp-cli-packages", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/sharing-wp-cli-packages.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/sharing-wp-cli-packages.md", + "parent": "guides" }, "shell-friends": { "title": "Shell Friends", "slug": "shell-friends", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/shell-friends.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/shell-friends.md", + "parent": "references" + }, + "then-an-email-should-be-sent-not-be-sent": { + "title": "Then \/^an email should (be sent|not be sent)$\/", + "slug": "then-an-email-should-be-sent-not-be-sent", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-an-email-should-be-sent-not-be-sent.md", + "parent": "behat-steps" + }, + "then-stdout-should-be-a-json-array-containing": { + "title": "Then \/^STDOUT should be a JSON array containing:$\/", + "slug": "then-stdout-should-be-a-json-array-containing", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-a-json-array-containing.md", + "parent": "behat-steps" + }, + "then-stdout-should-be-a-table-containing-rows": { + "title": "Then \/^STDOUT should be a table containing rows:$\/", + "slug": "then-stdout-should-be-a-table-containing-rows", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-a-table-containing-rows.md", + "parent": "behat-steps" + }, + "then-stdout-should-be-csv-containing": { + "title": "Then \/^STDOUT should be CSV containing:$\/", + "slug": "then-stdout-should-be-csv-containing", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-csv-containing.md", + "parent": "behat-steps" + }, + "then-stdout-should-be-json-containing": { + "title": "Then \/^STDOUT should be JSON containing:$\/", + "slug": "then-stdout-should-be-json-containing", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-json-containing.md", + "parent": "behat-steps" + }, + "then-stdout-should-be-yaml-containing": { + "title": "Then \/^STDOUT should be YAML containing:$\/", + "slug": "then-stdout-should-be-yaml-containing", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-yaml-containing.md", + "parent": "behat-steps" + }, + "then-stdout-should-end-with-a-table-containing-rows": { + "title": "Then \/^STDOUT should end with a table containing rows:$\/", + "slug": "then-stdout-should-end-with-a-table-containing-rows", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-end-with-a-table-containing-rows.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-be-a-number": { + "title": "Then \/^(STDOUT|STDERR) should be a number$\/", + "slug": "then-stdout-stderr-should-be-a-number", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-be-a-number.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-be-a-version-string-w": { + "title": "Then \/^(STDOUT|STDERR) should be a version string (<|<=|>|>=|==|=|!=|<>) ([+\\w.{}-]+)$\/", + "slug": "then-stdout-stderr-should-be-a-version-string-w", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-be-a-version-string-w.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-be-empty": { + "title": "Then \/^(STDOUT|STDERR) should be empty$\/", + "slug": "then-stdout-stderr-should-be-empty", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-be-empty.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-not-be-a-number": { + "title": "Then \/^(STDOUT|STDERR) should not be a number$\/", + "slug": "then-stdout-stderr-should-not-be-a-number", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-not-be-a-number.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-not-be-empty": { + "title": "Then \/^(STDOUT|STDERR) should not be empty$\/", + "slug": "then-stdout-stderr-should-not-be-empty", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-not-be-empty.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-not-match": { + "title": "Then \/^(STDOUT|STDERR) should( not)? match (((\\\/.+\\\/)|(#.+#))([a-z]+)?)$\/", + "slug": "then-stdout-stderr-should-not-match", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-not-match.md", + "parent": "behat-steps" + }, + "then-stdout-stderr-should-strictly-be-contain-not-contain": { + "title": "Then \/^(STDOUT|STDERR) should( strictly)? (be|contain|not contain):$\/", + "slug": "then-stdout-stderr-should-strictly-be-contain-not-contain", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-strictly-be-contain-not-contain.md", + "parent": "behat-steps" + }, + "then-the-contents-of-the-file-should-not-match": { + "title": "Then \/^the contents of the (.+) file should( not)? match (((\\\/.+\\\/)|(#.+#))([a-z]+)?)$\/", + "slug": "then-the-contents-of-the-file-should-not-match", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-contents-of-the-file-should-not-match.md", + "parent": "behat-steps" + }, + "then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain": { + "title": "Then \/^the (.+) (file|directory) should( strictly)? (exist|not exist|be:|contain:|not contain:)$\/", + "slug": "then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md", + "parent": "behat-steps" + }, + "then-the-http-status-code-should-be-code": { + "title": "Then the HTTP status code should be :code", + "slug": "then-the-http-status-code-should-be-code", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-http-status-code-should-be-code.md", + "parent": "behat-steps" + }, + "then-the-return-code-should-not-be": { + "title": "Then \/^the return code should( not)? be (\\d+)$\/", + "slug": "then-the-return-code-should-not-be", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-return-code-should-not-be.md", + "parent": "behat-steps" }, "tools": { "title": "Tools", "slug": "tools", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/tools.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/tools.md", + "parent": "references" }, "troubleshooting": { "title": "Troubleshooting Guide", "slug": "troubleshooting", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/troubleshooting.md", - "parent": null + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/guides\/troubleshooting.md", + "parent": "guides" + }, + "when-i-launch-in-the-background": { + "title": "When \/^I launch in the background `([^`]+)`$\/", + "slug": "when-i-launch-in-the-background", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-launch-in-the-background.md", + "parent": "behat-steps" + }, + "when-i-run-try": { + "title": "When \/^I (run|try) `([^`]+)`$\/", + "slug": "when-i-run-try", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-run-try.md", + "parent": "behat-steps" + }, + "when-i-run-try-from": { + "title": "When \/^I (run|try) `([^`]+)` from '([^\\s]+)'$\/", + "slug": "when-i-run-try-from", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-run-try-from.md", + "parent": "behat-steps" + }, + "when-i-run-try-the-previous-command-again": { + "title": "When \/^I (run|try) the previous command again$\/", + "slug": "when-i-run-try-the-previous-command-again", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-run-try-the-previous-command-again.md", + "parent": "behat-steps" }, "wp-cli-add-command": { "title": "WP_CLI::add_command()", "slug": "wp-cli-add-command", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-add-command.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-add-command.md", "parent": "internal-api" }, "wp-cli-add-hook": { "title": "WP_CLI::add_hook()", "slug": "wp-cli-add-hook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-add-hook.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-add-hook.md", "parent": "internal-api" }, "wp-cli-add-wp-hook": { "title": "WP_CLI::add_wp_hook()", "slug": "wp-cli-add-wp-hook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-add-wp-hook.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-add-wp-hook.md", "parent": "internal-api" }, "wp-cli-colorize": { "title": "WP_CLI::colorize()", "slug": "wp-cli-colorize", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-colorize.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-colorize.md", "parent": "internal-api" }, "wp-cli-confirm": { "title": "WP_CLI::confirm()", "slug": "wp-cli-confirm", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-confirm.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-confirm.md", "parent": "internal-api" }, "wp-cli-debug": { "title": "WP_CLI::debug()", "slug": "wp-cli-debug", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-debug.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-debug.md", "parent": "internal-api" }, "wp-cli-do-hook": { "title": "WP_CLI::do_hook()", "slug": "wp-cli-do-hook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-do-hook.md", - "parent": "internal-api" - }, - "wp-cli-error-multi-line": { - "title": "WP_CLI::error_multi_line()", - "slug": "wp-cli-error-multi-line", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-error-multi-line.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-do-hook.md", "parent": "internal-api" }, "wp-cli-error": { "title": "WP_CLI::error()", "slug": "wp-cli-error", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-error.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-error.md", + "parent": "internal-api" + }, + "wp-cli-error-multi-line": { + "title": "WP_CLI::error_multi_line()", + "slug": "wp-cli-error-multi-line", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-error-multi-line.md", "parent": "internal-api" }, "wp-cli-get-config": { "title": "WP_CLI::get_config()", "slug": "wp-cli-get-config", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-get-config.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-get-config.md", "parent": "internal-api" }, "wp-cli-get-php-binary": { "title": "WP_CLI::get_php_binary()", "slug": "wp-cli-get-php-binary", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-get-php-binary.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-get-php-binary.md", "parent": "internal-api" }, "wp-cli-halt": { "title": "WP_CLI::halt()", "slug": "wp-cli-halt", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-halt.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-halt.md", "parent": "internal-api" }, "wp-cli-has-config": { "title": "WP_CLI::has_config()", "slug": "wp-cli-has-config", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-has-config.md", - "parent": "internal-api" - }, - "wp-cli-launch-self": { - "title": "WP_CLI::launch_self()", - "slug": "wp-cli-launch-self", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-launch-self.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-has-config.md", "parent": "internal-api" }, "wp-cli-launch": { "title": "WP_CLI::launch()", "slug": "wp-cli-launch", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-launch.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-launch.md", + "parent": "internal-api" + }, + "wp-cli-launch-self": { + "title": "WP_CLI::launch_self()", + "slug": "wp-cli-launch-self", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-launch-self.md", "parent": "internal-api" }, "wp-cli-line": { "title": "WP_CLI::line()", "slug": "wp-cli-line", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-line.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-line.md", "parent": "internal-api" }, "wp-cli-log": { "title": "WP_CLI::log()", "slug": "wp-cli-log", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-log.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-log.md", "parent": "internal-api" }, "wp-cli-read-value": { "title": "WP_CLI::read_value()", "slug": "wp-cli-read-value", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-read-value.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-read-value.md", "parent": "internal-api" }, "wp-cli-run-command": { "title": "WP_CLI::run_command()", "slug": "wp-cli-run-command", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-run-command.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-run-command.md", "parent": "internal-api" }, "wp-cli-runcommand": { "title": "WP_CLI::runcommand()", "slug": "wp-cli-runcommand", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-runcommand.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-runcommand.md", "parent": "internal-api" }, "wp-cli-success": { "title": "WP_CLI::success()", "slug": "wp-cli-success", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-success.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-success.md", "parent": "internal-api" }, "wp-cli-utils-basename": { "title": "WP_CLI\\Utils\\basename()", "slug": "wp-cli-utils-basename", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-basename.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-basename.md", "parent": "internal-api" }, "wp-cli-utils-esc-like": { "title": "WP_CLI\\Utils\\esc_like()", "slug": "wp-cli-utils-esc-like", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-esc-like.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-esc-like.md", "parent": "internal-api" }, "wp-cli-utils-format-items": { "title": "WP_CLI\\Utils\\format_items()", "slug": "wp-cli-utils-format-items", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-format-items.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-format-items.md", "parent": "internal-api" }, "wp-cli-utils-get-flag-value": { "title": "WP_CLI\\Utils\\get_flag_value()", "slug": "wp-cli-utils-get-flag-value", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-flag-value.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-flag-value.md", "parent": "internal-api" }, "wp-cli-utils-get-home-dir": { "title": "WP_CLI\\Utils\\get_home_dir()", "slug": "wp-cli-utils-get-home-dir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-home-dir.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-home-dir.md", "parent": "internal-api" }, "wp-cli-utils-get-named-sem-ver": { "title": "WP_CLI\\Utils\\get_named_sem_ver()", "slug": "wp-cli-utils-get-named-sem-ver", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-named-sem-ver.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-named-sem-ver.md", "parent": "internal-api" }, "wp-cli-utils-get-php-binary": { "title": "WP_CLI\\Utils\\get_php_binary()", "slug": "wp-cli-utils-get-php-binary", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-php-binary.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-php-binary.md", "parent": "internal-api" }, "wp-cli-utils-get-temp-dir": { "title": "WP_CLI\\Utils\\get_temp_dir()", "slug": "wp-cli-utils-get-temp-dir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-temp-dir.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-temp-dir.md", "parent": "internal-api" }, "wp-cli-utils-http-request": { "title": "WP_CLI\\Utils\\http_request()", "slug": "wp-cli-utils-http-request", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-http-request.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-http-request.md", "parent": "internal-api" }, "wp-cli-utils-ispiped": { "title": "WP_CLI\\Utils\\isPiped()", "slug": "wp-cli-utils-ispiped", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-ispiped.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-ispiped.md", "parent": "internal-api" }, "wp-cli-utils-launch-editor-for-input": { "title": "WP_CLI\\Utils\\launch_editor_for_input()", "slug": "wp-cli-utils-launch-editor-for-input", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-launch-editor-for-input.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-launch-editor-for-input.md", "parent": "internal-api" }, "wp-cli-utils-make-progress-bar": { "title": "WP_CLI\\Utils\\make_progress_bar()", "slug": "wp-cli-utils-make-progress-bar", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-make-progress-bar.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-make-progress-bar.md", "parent": "internal-api" }, "wp-cli-utils-normalize-path": { "title": "WP_CLI\\Utils\\normalize_path()", "slug": "wp-cli-utils-normalize-path", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-normalize-path.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-normalize-path.md", "parent": "internal-api" }, "wp-cli-utils-parse-ssh-url": { "title": "WP_CLI\\Utils\\parse_ssh_url()", "slug": "wp-cli-utils-parse-ssh-url", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-parse-ssh-url.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-parse-ssh-url.md", "parent": "internal-api" }, "wp-cli-utils-parse-str-to-argv": { "title": "WP_CLI\\Utils\\parse_str_to_argv()", "slug": "wp-cli-utils-parse-str-to-argv", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-parse-str-to-argv.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-parse-str-to-argv.md", "parent": "internal-api" }, "wp-cli-utils-proc-open-compat": { "title": "WP_CLI\\Utils\\proc_open_compat()", "slug": "wp-cli-utils-proc-open-compat", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-proc-open-compat.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-proc-open-compat.md", "parent": "internal-api" }, "wp-cli-utils-report-batch-operation-results": { "title": "WP_CLI\\Utils\\report_batch_operation_results()", "slug": "wp-cli-utils-report-batch-operation-results", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-report-batch-operation-results.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-report-batch-operation-results.md", "parent": "internal-api" }, "wp-cli-utils-trailingslashit": { "title": "WP_CLI\\Utils\\trailingslashit()", "slug": "wp-cli-utils-trailingslashit", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-trailingslashit.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-trailingslashit.md", "parent": "internal-api" }, "wp-cli-utils-write-csv": { "title": "WP_CLI\\Utils\\write_csv()", "slug": "wp-cli-utils-write-csv", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-write-csv.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-write-csv.md", "parent": "internal-api" }, "wp-cli-warning": { "title": "WP_CLI::warning()", "slug": "wp-cli-warning", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-warning.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-warning.md", "parent": "internal-api" - }, - "given-a-custom-wp-content-directory": { - "title": "Given a custom wp-content directory", - "slug": "given-a-custom-wp-content-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-custom-wp-content-directory.md", - "parent": "behat-steps" - }, - "given-a-database": { - "title": "Given a database", - "slug": "given-a-database", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-database.md", - "parent": "behat-steps" - }, - "given-a-dependency-on-current-wp-cli": { - "title": "Given a dependency on current wp-cli", - "slug": "given-a-dependency-on-current-wp-cli", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-dependency-on-current-wp-cli.md", - "parent": "behat-steps" - }, - "given-a-downloaded-phar-with-the-same-version-version": { - "title": "Given \/^a downloaded Phar with (?:the same version|version "([^"]+)")$\/", - "slug": "given-a-downloaded-phar-with-the-same-version-version", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-downloaded-phar-with-the-same-version-version.md", - "parent": "behat-steps" - }, - "given-a-misconfigured-wp-content-dir-constant-directory": { - "title": "Given a misconfigured WP_CONTENT_DIR constant directory", - "slug": "given-a-misconfigured-wp-content-dir-constant-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-misconfigured-wp-content-dir-constant-directory.md", - "parent": "behat-steps" - }, - "given-a-new-phar-with-the-same-version-version": { - "title": "Given \/^a new Phar with (?:the same version|version "([^"]+)")$\/", - "slug": "given-a-new-phar-with-the-same-version-version", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-new-phar-with-the-same-version-version.md", - "parent": "behat-steps" - }, - "given-a-php-built-in-web-server-to-serve-subdir": { - "title": "Given a PHP built-in web server to serve :subdir", - "slug": "given-a-php-built-in-web-server-to-serve-subdir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-php-built-in-web-server-to-serve-subdir.md", - "parent": "behat-steps" - }, - "given-a-php-built-in-web-server": { - "title": "Given a PHP built-in web server", - "slug": "given-a-php-built-in-web-server", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-php-built-in-web-server.md", - "parent": "behat-steps" - }, - "given-a-wp-installation-in-subdir": { - "title": "Given a WP install(ation) in :subdir", - "slug": "given-a-wp-installation-in-subdir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation-in-subdir.md", - "parent": "behat-steps" - }, - "given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory": { - "title": "Given a WP install(ation) with Composer and a custom vendor directory :vendor_directory", - "slug": "given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md", - "parent": "behat-steps" - }, - "given-a-wp-installation-with-composer": { - "title": "Given a WP install(ation) with Composer", - "slug": "given-a-wp-installation-with-composer", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation-with-composer.md", - "parent": "behat-steps" - }, - "given-a-wp-installation": { - "title": "Given a WP install(ation)", - "slug": "given-a-wp-installation", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation.md", - "parent": "behat-steps" - }, - "given-a-wp-multisite-subdirectory-subdomaininstall-installation": { - "title": "Given \/^a WP multisite (subdirectory|subdomain)?\\s?(install|installation)$\/", - "slug": "given-a-wp-multisite-subdirectory-subdomaininstall-installation", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md", - "parent": "behat-steps" - }, - "given-an-empty-cache": { - "title": "Given an empty cache", - "slug": "given-an-empty-cache", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-empty-cache.md", - "parent": "behat-steps" - }, - "given-an-empty-directory": { - "title": "Given an empty directory", - "slug": "given-an-empty-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-empty-directory.md", - "parent": "behat-steps" - }, - "given-an-empty-non-existent-directory": { - "title": "Given \/^an? (empty|non-existent) ([^\\s]+) directory$\/", - "slug": "given-an-empty-non-existent-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-empty-non-existent-directory.md", - "parent": "behat-steps" - }, - "given-an-file-cache-file": { - "title": "Given \/^an? ([^\\s]+) (file|cache file):$\/", - "slug": "given-an-file-cache-file", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-file-cache-file.md", - "parent": "behat-steps" - }, - "given-download": { - "title": "Given download:", - "slug": "given-download", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-download.md", - "parent": "behat-steps" - }, - "given-replaced-with-in-the-file": { - "title": "Given \/^"([^"]+)" replaced with "([^"]+)" in the ([^\\s]+) file$\/", - "slug": "given-replaced-with-in-the-file", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-replaced-with-in-the-file.md", - "parent": "behat-steps" - }, - "given-save-stdout-stderr-as": { - "title": "Given \/^save (STDOUT|STDERR) ([\\'].+[^\\'])?\\s?as \\{(\\w+)\\}$\/", - "slug": "given-save-stdout-stderr-as", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-save-stdout-stderr-as.md", - "parent": "behat-steps" - }, - "given-save-the-file-as": { - "title": "Given \/^save the (.+) file ([\\'].+[^\\'])?as \\{(\\w+)\\}$\/", - "slug": "given-save-the-file-as", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-save-the-file-as.md", - "parent": "behat-steps" - }, - "given-that-http-requests-to-will-respond-with": { - "title": "Given \/^that HTTP requests to (.*?) will respond with:$\/", - "slug": "given-that-http-requests-to-will-respond-with", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-that-http-requests-to-will-respond-with.md", - "parent": "behat-steps" - }, - "given-these-installed-and-active-plugins": { - "title": "Given these installed and active plugins:", - "slug": "given-these-installed-and-active-plugins", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-these-installed-and-active-plugins.md", - "parent": "behat-steps" - }, - "given-wp-config-php": { - "title": "Given wp-config.php", - "slug": "given-wp-config-php", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-wp-config-php.md", - "parent": "behat-steps" - }, - "given-wp-files": { - "title": "Given WP files", - "slug": "given-wp-files", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-wp-files.md", - "parent": "behat-steps" - }, - "then-an-email-should-be-sent-not-be-sent": { - "title": "Then \/^an email should (be sent|not be sent)$\/", - "slug": "then-an-email-should-be-sent-not-be-sent", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-an-email-should-be-sent-not-be-sent.md", - "parent": "behat-steps" - }, - "then-stdout-should-be-a-json-array-containing": { - "title": "Then \/^STDOUT should be a JSON array containing:$\/", - "slug": "then-stdout-should-be-a-json-array-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-a-json-array-containing.md", - "parent": "behat-steps" - }, - "then-stdout-should-be-a-table-containing-rows": { - "title": "Then \/^STDOUT should be a table containing rows:$\/", - "slug": "then-stdout-should-be-a-table-containing-rows", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-a-table-containing-rows.md", - "parent": "behat-steps" - }, - "then-stdout-should-be-csv-containing": { - "title": "Then \/^STDOUT should be CSV containing:$\/", - "slug": "then-stdout-should-be-csv-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-csv-containing.md", - "parent": "behat-steps" - }, - "then-stdout-should-be-json-containing": { - "title": "Then \/^STDOUT should be JSON containing:$\/", - "slug": "then-stdout-should-be-json-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-json-containing.md", - "parent": "behat-steps" - }, - "then-stdout-should-be-yaml-containing": { - "title": "Then \/^STDOUT should be YAML containing:$\/", - "slug": "then-stdout-should-be-yaml-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-yaml-containing.md", - "parent": "behat-steps" - }, - "then-stdout-should-end-with-a-table-containing-rows": { - "title": "Then \/^STDOUT should end with a table containing rows:$\/", - "slug": "then-stdout-should-end-with-a-table-containing-rows", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-end-with-a-table-containing-rows.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-be-a-number": { - "title": "Then \/^(STDOUT|STDERR) should be a number$\/", - "slug": "then-stdout-stderr-should-be-a-number", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-be-a-number.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-be-a-version-string-w": { - "title": "Then \/^(STDOUT|STDERR) should be a version string (<|<=|>|>=|==|=|!=|<>) ([+\\w.{}-]+)$\/", - "slug": "then-stdout-stderr-should-be-a-version-string-w", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-be-a-version-string-w.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-be-empty": { - "title": "Then \/^(STDOUT|STDERR) should be empty$\/", - "slug": "then-stdout-stderr-should-be-empty", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-be-empty.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-not-be-a-number": { - "title": "Then \/^(STDOUT|STDERR) should not be a number$\/", - "slug": "then-stdout-stderr-should-not-be-a-number", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-not-be-a-number.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-not-be-empty": { - "title": "Then \/^(STDOUT|STDERR) should not be empty$\/", - "slug": "then-stdout-stderr-should-not-be-empty", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-not-be-empty.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-not-match": { - "title": "Then \/^(STDOUT|STDERR) should( not)? match (((\\\/.+\\\/)|(#.+#))([a-z]+)?)$\/", - "slug": "then-stdout-stderr-should-not-match", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-not-match.md", - "parent": "behat-steps" - }, - "then-stdout-stderr-should-strictly-be-contain-not-contain": { - "title": "Then \/^(STDOUT|STDERR) should( strictly)? (be|contain|not contain):$\/", - "slug": "then-stdout-stderr-should-strictly-be-contain-not-contain", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-strictly-be-contain-not-contain.md", - "parent": "behat-steps" - }, - "then-the-contents-of-the-file-should-not-match": { - "title": "Then \/^the contents of the (.+) file should( not)? match (((\\\/.+\\\/)|(#.+#))([a-z]+)?)$\/", - "slug": "then-the-contents-of-the-file-should-not-match", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-contents-of-the-file-should-not-match.md", - "parent": "behat-steps" - }, - "then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain": { - "title": "Then \/^the (.+) (file|directory) should( strictly)? (exist|not exist|be:|contain:|not contain:)$\/", - "slug": "then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md", - "parent": "behat-steps" - }, - "then-the-http-status-code-should-be-code": { - "title": "Then the HTTP status code should be :code", - "slug": "then-the-http-status-code-should-be-code", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-http-status-code-should-be-code.md", - "parent": "behat-steps" - }, - "then-the-return-code-should-not-be": { - "title": "Then \/^the return code should( not)? be (\\d+)$\/", - "slug": "then-the-return-code-should-not-be", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-return-code-should-not-be.md", - "parent": "behat-steps" - }, - "when-i-launch-in-the-background": { - "title": "When \/^I launch in the background `([^`]+)`$\/", - "slug": "when-i-launch-in-the-background", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-launch-in-the-background.md", - "parent": "behat-steps" - }, - "when-i-run-try-from": { - "title": "When \/^I (run|try) `([^`]+)` from '([^\\s]+)'$\/", - "slug": "when-i-run-try-from", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-run-try-from.md", - "parent": "behat-steps" - }, - "when-i-run-try-the-previous-command-again": { - "title": "When \/^I (run|try) the previous command again$\/", - "slug": "when-i-run-try-the-previous-command-again", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-run-try-the-previous-command-again.md", - "parent": "behat-steps" - }, - "when-i-run-try": { - "title": "When \/^I (run|try) `([^`]+)`$\/", - "slug": "when-i-run-try", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-run-try.md", - "parent": "behat-steps" } } \ No newline at end of file diff --git a/contributions.md b/contributions.md new file mode 100644 index 00000000..450a8fbc --- /dev/null +++ b/contributions.md @@ -0,0 +1,15 @@ +# Contributions + +* **[Bug reports](https://make.wordpress.org/cli/handbook/contributions/bug-reports/)** - Help ensure your issue is resolved in a timely manner. +* **[Contributing](https://make.wordpress.org/cli/handbook/contributions/contributing/)** - An introduction to the contributing process. +* **[WordCamp Contributor Day](https://make.wordpress.org/cli/handbook/contributions/contributor-day/)** - Quick-start guide for WordCamp Contributor Days. +* **[Ideas](https://github.com/wp-cli/ideas)** - Up-vote existing ideas or submit your own. +* **[Governance](https://make.wordpress.org/cli/handbook/contributions/governance/)** - Summary of those behind WP-CLI. +* **[Implementation details](https://make.wordpress.org/cli/handbook/contributions/implementation-details/)** - Catalog of historical design decisions. +* **[Philosophy](https://make.wordpress.org/cli/handbook/contributions/philosophy/)** - Guidelines which inform project scope, command organization, and behavior. +* **[Pull requests](https://make.wordpress.org/cli/handbook/contributions/pull-requests/)** - Submit your first bug fix or new feature. +* **[Release checklist](https://make.wordpress.org/cli/handbook/contributions/release-checklist/)** - Tasks performed during the process of tagging a release. +* **[Roadmap](https://make.wordpress.org/cli/handbook/contributions/roadmap/)** - Where WP-CLI is going in the future. +* **[Code Review](https://make.wordpress.org/cli/handbook/contributions/code-review/)** - Quality Assurance on WP-CLI +* **[Committers credo](https://make.wordpress.org/cli/handbook/contributions/committers-credo/)** - Product quality, Stellar judgement, Consistent participation +* **[Repository Management](https://make.wordpress.org/cli/handbook/contributions/repository-management/)** - Naming, Versions, Milestones, Labels diff --git a/bug-reports.md b/contributions/bug-reports.md similarity index 100% rename from bug-reports.md rename to contributions/bug-reports.md diff --git a/code-review.md b/contributions/code-review.md similarity index 100% rename from code-review.md rename to contributions/code-review.md diff --git a/committers-credo.md b/contributions/committers-credo.md similarity index 100% rename from committers-credo.md rename to contributions/committers-credo.md diff --git a/contributing.md b/contributions/contributing.md similarity index 100% rename from contributing.md rename to contributions/contributing.md diff --git a/contributor-day.md b/contributions/contributor-day.md similarity index 100% rename from contributor-day.md rename to contributions/contributor-day.md diff --git a/governance.md b/contributions/governance.md similarity index 100% rename from governance.md rename to contributions/governance.md diff --git a/hack-day.md b/contributions/hack-day.md similarity index 100% rename from hack-day.md rename to contributions/hack-day.md diff --git a/implementation-details.md b/contributions/implementation-details.md similarity index 100% rename from implementation-details.md rename to contributions/implementation-details.md diff --git a/philosophy.md b/contributions/philosophy.md similarity index 100% rename from philosophy.md rename to contributions/philosophy.md diff --git a/pull-requests.md b/contributions/pull-requests.md similarity index 100% rename from pull-requests.md rename to contributions/pull-requests.md diff --git a/release-checklist.md b/contributions/release-checklist.md similarity index 100% rename from release-checklist.md rename to contributions/release-checklist.md diff --git a/repository-management.md b/contributions/repository-management.md similarity index 100% rename from repository-management.md rename to contributions/repository-management.md diff --git a/roadmap.md b/contributions/roadmap.md similarity index 100% rename from roadmap.md rename to contributions/roadmap.md diff --git a/guides.md b/guides.md new file mode 100644 index 00000000..af4d23b2 --- /dev/null +++ b/guides.md @@ -0,0 +1,12 @@ +# Guides + +* **[Installing](https://make.wordpress.org/cli/handbook/guides/installing/)** - Recommended and alternative installation mechanisms. +* **[Quick start](https://make.wordpress.org/cli/handbook/guides/quick-start/)** - Where to begin after you've installed WP-CLI for the first time. +* **[Running commands remotely](https://make.wordpress.org/cli/handbook/guides/running-commands-remotely/)** - Learn how to remotely control multiple servers at once. +* **[Commands cookbook](https://make.wordpress.org/cli/handbook/guides/commands-cookbook/)** - The full 101 how commands work, writing your own, and sharing them with the world. +* **[Common issues and their fixes](https://make.wordpress.org/cli/handbook/guides/common-issues/)** - In case of fire, break glass. +* **[External resources](https://make.wordpress.org/cli/handbook/guides/external-resources/)** - Blog posts, slides and videos from users. +* **[Force output to a specific locale](https://make.wordpress.org/cli/handbook/guides/force-output-specific-locale/)** - Localisation issue +* **[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advise +* **[Sharing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/sharing-wp-cli-packages/)** - Some words about your environment +* **[Troubleshooting Guide](https://make.wordpress.org/cli/handbook/guides/troubleshooting/)** - Some help to troubleshoot diff --git a/commands-cookbook.md b/guides/commands-cookbook.md similarity index 100% rename from commands-cookbook.md rename to guides/commands-cookbook.md diff --git a/common-issues.md b/guides/common-issues.md similarity index 100% rename from common-issues.md rename to guides/common-issues.md diff --git a/doctor.md b/guides/doctor.md similarity index 100% rename from doctor.md rename to guides/doctor.md diff --git a/doctor-check-constant-value.md b/guides/doctor/doctor-check-constant-value.md similarity index 100% rename from doctor-check-constant-value.md rename to guides/doctor/doctor-check-constant-value.md diff --git a/doctor-check-file-contents.md b/guides/doctor/doctor-check-file-contents.md similarity index 100% rename from doctor-check-file-contents.md rename to guides/doctor/doctor-check-file-contents.md diff --git a/doctor-check-option-value.md b/guides/doctor/doctor-check-option-value.md similarity index 100% rename from doctor-check-option-value.md rename to guides/doctor/doctor-check-option-value.md diff --git a/doctor-check-plugin-status.md b/guides/doctor/doctor-check-plugin-status.md similarity index 100% rename from doctor-check-plugin-status.md rename to guides/doctor/doctor-check-plugin-status.md diff --git a/doctor-customize-config.md b/guides/doctor/doctor-customize-config.md similarity index 100% rename from doctor-customize-config.md rename to guides/doctor/doctor-customize-config.md diff --git a/doctor-default-checks.md b/guides/doctor/doctor-default-checks.md similarity index 100% rename from doctor-default-checks.md rename to guides/doctor/doctor-default-checks.md diff --git a/doctor-write-custom-check.md b/guides/doctor/doctor-write-custom-check.md similarity index 100% rename from doctor-write-custom-check.md rename to guides/doctor/doctor-write-custom-check.md diff --git a/external-resources.md b/guides/external-resources.md similarity index 100% rename from external-resources.md rename to guides/external-resources.md diff --git a/force-output-specific-locale.md b/guides/force-output-specific-locale.md similarity index 100% rename from force-output-specific-locale.md rename to guides/force-output-specific-locale.md diff --git a/installing.md b/guides/installing.md similarity index 100% rename from installing.md rename to guides/installing.md diff --git a/quick-start.md b/guides/quick-start.md similarity index 100% rename from quick-start.md rename to guides/quick-start.md diff --git a/running-commands-remotely.md b/guides/running-commands-remotely.md similarity index 100% rename from running-commands-remotely.md rename to guides/running-commands-remotely.md diff --git a/sharing-wp-cli-packages.md b/guides/sharing-wp-cli-packages.md similarity index 100% rename from sharing-wp-cli-packages.md rename to guides/sharing-wp-cli-packages.md diff --git a/troubleshooting.md b/guides/troubleshooting.md similarity index 100% rename from troubleshooting.md rename to guides/troubleshooting.md diff --git a/how-to-create-custom-plugins.md b/how-to/how-to-create-custom-plugins.md similarity index 99% rename from how-to-create-custom-plugins.md rename to how-to/how-to-create-custom-plugins.md index ecd41154..151b874c 100644 --- a/how-to-create-custom-plugins.md +++ b/how-to/how-to-create-custom-plugins.md @@ -1,4 +1,4 @@ -# How to create a custom plugin: +# How to create a custom plugin If you want to create your plugins, WP-CLI has a powerful scaffold command that allows us to generate starter code. In this guide we will see how to generate starter code for a basic plugin. diff --git a/how-to-install.md b/how-to/how-to-install.md similarity index 100% rename from how-to-install.md rename to how-to/how-to-install.md diff --git a/how-to-maintenance-mode.md b/how-to/how-to-maintenance-mode.md similarity index 100% rename from how-to-maintenance-mode.md rename to how-to/how-to-maintenance-mode.md diff --git a/how-to-start-webserver.md b/how-to/how-to-start-webserver.md similarity index 100% rename from how-to-start-webserver.md rename to how-to/how-to-start-webserver.md diff --git a/identify-plugin-theme-conflict.md b/how-to/identify-plugin-theme-conflict.md similarity index 100% rename from identify-plugin-theme-conflict.md rename to how-to/identify-plugin-theme-conflict.md diff --git a/plugin-unit-tests.md b/how-to/plugin-unit-tests.md similarity index 100% rename from plugin-unit-tests.md rename to how-to/plugin-unit-tests.md diff --git a/index.md b/index.md index 31f63b99..14d80404 100644 --- a/index.md +++ b/index.md @@ -15,7 +15,7 @@ Can’t find what you’re looking for? [Open an issue](https://github.com/wp-cl * **[Force output to a specific locale](https://make.wordpress.org/cli/handbook/guides/force-output-specific-locale/)** - Localisation issue * **[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advise * **[Sharing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/sharing-wp-cli-packages/)** - Some words about your environment -* **[Troubleshooting Guide](https://make.wordpress.org/cli/handbook/guides/troubleshooting/)** - Some help to troubleshoot +* **[Troubleshooting Guide](https://make.wordpress.org/cli/handbook/guides/troubleshooting/)** - Some help to troubleshoot ## References @@ -41,7 +41,7 @@ Can’t find what you’re looking for? [Open an issue](https://github.com/wp-cl * **[Roadmap](https://make.wordpress.org/cli/handbook/contributions/roadmap/)** - Where WP-CLI is going in the future. * **[Code Review](https://make.wordpress.org/cli/handbook/contributions/code-review/)** - Quality Assurance on WP-CLI * **[Committers credo](https://make.wordpress.org/cli/handbook/contributions/committers-credo/)** - Product quality, Stellar judgement, Consistent participation -* **[Repository Management](https://make.wordpress.org/cli/handbook/contributions/repository-management/)** - Naming, Versions, Milestones, Labels +* **[Repository Management](https://make.wordpress.org/cli/handbook/contributions/repository-management/)** - Naming, Versions, Milestones, Labels ## Misc diff --git a/references.md b/references.md new file mode 100644 index 00000000..57a9b650 --- /dev/null +++ b/references.md @@ -0,0 +1,9 @@ +# References + +* **[Global parameters](https://make.wordpress.org/cli/handbook/references/config/)** - Variables defining how a command is executed, including which WordPress user the command is run as and which WordPress instance the command is run against. +* **[Built-in commands](https://developer.wordpress.org/cli/commands/)** - Commands included in every copy of WP-CLI. +* **[Internal API](https://make.wordpress.org/cli/handbook/references/internal-api/)** - Stable utilities considered safe to use in community commands. +* **[Documentation standards](https://make.wordpress.org/cli/handbook/references/documentation-standards/)** - Standards for annotating WP-CLI commands. +* **[Hosting companies](https://make.wordpress.org/cli/handbook/references/hosting-companies/)** - List of hosting companies where WP-CLI is installed by default. +* **[Shell friends](https://make.wordpress.org/cli/handbook/references/shell-friends/)** - Helpful shortcuts for bash and zsh. +* **[Integrated tools](https://make.wordpress.org/cli/handbook/references/tools/)** - Plugins, wrappers, and other projects that integrate with WP-CLI in some form. diff --git a/behat-steps.md b/references/behat-steps.md similarity index 100% rename from behat-steps.md rename to references/behat-steps.md diff --git a/behat-steps/given-a-custom-wp-content-directory.md b/references/behat-steps/given-a-custom-wp-content-directory.md similarity index 100% rename from behat-steps/given-a-custom-wp-content-directory.md rename to references/behat-steps/given-a-custom-wp-content-directory.md diff --git a/behat-steps/given-a-database.md b/references/behat-steps/given-a-database.md similarity index 100% rename from behat-steps/given-a-database.md rename to references/behat-steps/given-a-database.md diff --git a/behat-steps/given-a-dependency-on-current-wp-cli.md b/references/behat-steps/given-a-dependency-on-current-wp-cli.md similarity index 100% rename from behat-steps/given-a-dependency-on-current-wp-cli.md rename to references/behat-steps/given-a-dependency-on-current-wp-cli.md diff --git a/behat-steps/given-a-downloaded-phar-with-the-same-version-version.md b/references/behat-steps/given-a-downloaded-phar-with-the-same-version-version.md similarity index 100% rename from behat-steps/given-a-downloaded-phar-with-the-same-version-version.md rename to references/behat-steps/given-a-downloaded-phar-with-the-same-version-version.md diff --git a/behat-steps/given-a-misconfigured-wp-content-dir-constant-directory.md b/references/behat-steps/given-a-misconfigured-wp-content-dir-constant-directory.md similarity index 100% rename from behat-steps/given-a-misconfigured-wp-content-dir-constant-directory.md rename to references/behat-steps/given-a-misconfigured-wp-content-dir-constant-directory.md diff --git a/behat-steps/given-a-new-phar-with-the-same-version-version.md b/references/behat-steps/given-a-new-phar-with-the-same-version-version.md similarity index 100% rename from behat-steps/given-a-new-phar-with-the-same-version-version.md rename to references/behat-steps/given-a-new-phar-with-the-same-version-version.md diff --git a/behat-steps/given-a-php-built-in-web-server-to-serve-subdir.md b/references/behat-steps/given-a-php-built-in-web-server-to-serve-subdir.md similarity index 100% rename from behat-steps/given-a-php-built-in-web-server-to-serve-subdir.md rename to references/behat-steps/given-a-php-built-in-web-server-to-serve-subdir.md diff --git a/behat-steps/given-a-php-built-in-web-server.md b/references/behat-steps/given-a-php-built-in-web-server.md similarity index 100% rename from behat-steps/given-a-php-built-in-web-server.md rename to references/behat-steps/given-a-php-built-in-web-server.md diff --git a/behat-steps/given-a-wp-installation-in-subdir.md b/references/behat-steps/given-a-wp-installation-in-subdir.md similarity index 100% rename from behat-steps/given-a-wp-installation-in-subdir.md rename to references/behat-steps/given-a-wp-installation-in-subdir.md diff --git a/behat-steps/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md b/references/behat-steps/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md similarity index 100% rename from behat-steps/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md rename to references/behat-steps/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md diff --git a/behat-steps/given-a-wp-installation-with-composer.md b/references/behat-steps/given-a-wp-installation-with-composer.md similarity index 100% rename from behat-steps/given-a-wp-installation-with-composer.md rename to references/behat-steps/given-a-wp-installation-with-composer.md diff --git a/behat-steps/given-a-wp-installation.md b/references/behat-steps/given-a-wp-installation.md similarity index 100% rename from behat-steps/given-a-wp-installation.md rename to references/behat-steps/given-a-wp-installation.md diff --git a/behat-steps/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md b/references/behat-steps/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md similarity index 100% rename from behat-steps/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md rename to references/behat-steps/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md diff --git a/behat-steps/given-an-empty-cache.md b/references/behat-steps/given-an-empty-cache.md similarity index 100% rename from behat-steps/given-an-empty-cache.md rename to references/behat-steps/given-an-empty-cache.md diff --git a/behat-steps/given-an-empty-directory.md b/references/behat-steps/given-an-empty-directory.md similarity index 100% rename from behat-steps/given-an-empty-directory.md rename to references/behat-steps/given-an-empty-directory.md diff --git a/behat-steps/given-an-empty-non-existent-directory.md b/references/behat-steps/given-an-empty-non-existent-directory.md similarity index 100% rename from behat-steps/given-an-empty-non-existent-directory.md rename to references/behat-steps/given-an-empty-non-existent-directory.md diff --git a/behat-steps/given-an-file-cache-file.md b/references/behat-steps/given-an-file-cache-file.md similarity index 100% rename from behat-steps/given-an-file-cache-file.md rename to references/behat-steps/given-an-file-cache-file.md diff --git a/behat-steps/given-download.md b/references/behat-steps/given-download.md similarity index 100% rename from behat-steps/given-download.md rename to references/behat-steps/given-download.md diff --git a/behat-steps/given-replaced-with-in-the-file.md b/references/behat-steps/given-replaced-with-in-the-file.md similarity index 100% rename from behat-steps/given-replaced-with-in-the-file.md rename to references/behat-steps/given-replaced-with-in-the-file.md diff --git a/behat-steps/given-save-stdout-stderr-as.md b/references/behat-steps/given-save-stdout-stderr-as.md similarity index 100% rename from behat-steps/given-save-stdout-stderr-as.md rename to references/behat-steps/given-save-stdout-stderr-as.md diff --git a/behat-steps/given-save-the-file-as.md b/references/behat-steps/given-save-the-file-as.md similarity index 100% rename from behat-steps/given-save-the-file-as.md rename to references/behat-steps/given-save-the-file-as.md diff --git a/behat-steps/given-that-http-requests-to-will-respond-with.md b/references/behat-steps/given-that-http-requests-to-will-respond-with.md similarity index 100% rename from behat-steps/given-that-http-requests-to-will-respond-with.md rename to references/behat-steps/given-that-http-requests-to-will-respond-with.md diff --git a/behat-steps/given-these-installed-and-active-plugins.md b/references/behat-steps/given-these-installed-and-active-plugins.md similarity index 100% rename from behat-steps/given-these-installed-and-active-plugins.md rename to references/behat-steps/given-these-installed-and-active-plugins.md diff --git a/behat-steps/given-wp-config-php.md b/references/behat-steps/given-wp-config-php.md similarity index 100% rename from behat-steps/given-wp-config-php.md rename to references/behat-steps/given-wp-config-php.md diff --git a/behat-steps/given-wp-files.md b/references/behat-steps/given-wp-files.md similarity index 100% rename from behat-steps/given-wp-files.md rename to references/behat-steps/given-wp-files.md diff --git a/behat-steps/then-an-email-should-be-sent-not-be-sent.md b/references/behat-steps/then-an-email-should-be-sent-not-be-sent.md similarity index 100% rename from behat-steps/then-an-email-should-be-sent-not-be-sent.md rename to references/behat-steps/then-an-email-should-be-sent-not-be-sent.md diff --git a/behat-steps/then-stdout-should-be-a-json-array-containing.md b/references/behat-steps/then-stdout-should-be-a-json-array-containing.md similarity index 100% rename from behat-steps/then-stdout-should-be-a-json-array-containing.md rename to references/behat-steps/then-stdout-should-be-a-json-array-containing.md diff --git a/behat-steps/then-stdout-should-be-a-table-containing-rows.md b/references/behat-steps/then-stdout-should-be-a-table-containing-rows.md similarity index 100% rename from behat-steps/then-stdout-should-be-a-table-containing-rows.md rename to references/behat-steps/then-stdout-should-be-a-table-containing-rows.md diff --git a/behat-steps/then-stdout-should-be-csv-containing.md b/references/behat-steps/then-stdout-should-be-csv-containing.md similarity index 100% rename from behat-steps/then-stdout-should-be-csv-containing.md rename to references/behat-steps/then-stdout-should-be-csv-containing.md diff --git a/behat-steps/then-stdout-should-be-json-containing.md b/references/behat-steps/then-stdout-should-be-json-containing.md similarity index 100% rename from behat-steps/then-stdout-should-be-json-containing.md rename to references/behat-steps/then-stdout-should-be-json-containing.md diff --git a/behat-steps/then-stdout-should-be-yaml-containing.md b/references/behat-steps/then-stdout-should-be-yaml-containing.md similarity index 100% rename from behat-steps/then-stdout-should-be-yaml-containing.md rename to references/behat-steps/then-stdout-should-be-yaml-containing.md diff --git a/behat-steps/then-stdout-should-end-with-a-table-containing-rows.md b/references/behat-steps/then-stdout-should-end-with-a-table-containing-rows.md similarity index 100% rename from behat-steps/then-stdout-should-end-with-a-table-containing-rows.md rename to references/behat-steps/then-stdout-should-end-with-a-table-containing-rows.md diff --git a/behat-steps/then-stdout-stderr-should-be-a-number.md b/references/behat-steps/then-stdout-stderr-should-be-a-number.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-be-a-number.md rename to references/behat-steps/then-stdout-stderr-should-be-a-number.md diff --git a/behat-steps/then-stdout-stderr-should-be-a-version-string-w.md b/references/behat-steps/then-stdout-stderr-should-be-a-version-string-w.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-be-a-version-string-w.md rename to references/behat-steps/then-stdout-stderr-should-be-a-version-string-w.md diff --git a/behat-steps/then-stdout-stderr-should-be-empty.md b/references/behat-steps/then-stdout-stderr-should-be-empty.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-be-empty.md rename to references/behat-steps/then-stdout-stderr-should-be-empty.md diff --git a/behat-steps/then-stdout-stderr-should-not-be-a-number.md b/references/behat-steps/then-stdout-stderr-should-not-be-a-number.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-not-be-a-number.md rename to references/behat-steps/then-stdout-stderr-should-not-be-a-number.md diff --git a/behat-steps/then-stdout-stderr-should-not-be-empty.md b/references/behat-steps/then-stdout-stderr-should-not-be-empty.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-not-be-empty.md rename to references/behat-steps/then-stdout-stderr-should-not-be-empty.md diff --git a/behat-steps/then-stdout-stderr-should-not-match.md b/references/behat-steps/then-stdout-stderr-should-not-match.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-not-match.md rename to references/behat-steps/then-stdout-stderr-should-not-match.md diff --git a/behat-steps/then-stdout-stderr-should-strictly-be-contain-not-contain.md b/references/behat-steps/then-stdout-stderr-should-strictly-be-contain-not-contain.md similarity index 100% rename from behat-steps/then-stdout-stderr-should-strictly-be-contain-not-contain.md rename to references/behat-steps/then-stdout-stderr-should-strictly-be-contain-not-contain.md diff --git a/behat-steps/then-the-contents-of-the-file-should-not-match.md b/references/behat-steps/then-the-contents-of-the-file-should-not-match.md similarity index 100% rename from behat-steps/then-the-contents-of-the-file-should-not-match.md rename to references/behat-steps/then-the-contents-of-the-file-should-not-match.md diff --git a/behat-steps/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md b/references/behat-steps/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md similarity index 100% rename from behat-steps/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md rename to references/behat-steps/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md diff --git a/behat-steps/then-the-http-status-code-should-be-code.md b/references/behat-steps/then-the-http-status-code-should-be-code.md similarity index 100% rename from behat-steps/then-the-http-status-code-should-be-code.md rename to references/behat-steps/then-the-http-status-code-should-be-code.md diff --git a/behat-steps/then-the-return-code-should-not-be.md b/references/behat-steps/then-the-return-code-should-not-be.md similarity index 100% rename from behat-steps/then-the-return-code-should-not-be.md rename to references/behat-steps/then-the-return-code-should-not-be.md diff --git a/behat-steps/when-i-launch-in-the-background.md b/references/behat-steps/when-i-launch-in-the-background.md similarity index 100% rename from behat-steps/when-i-launch-in-the-background.md rename to references/behat-steps/when-i-launch-in-the-background.md diff --git a/behat-steps/when-i-run-try-from.md b/references/behat-steps/when-i-run-try-from.md similarity index 100% rename from behat-steps/when-i-run-try-from.md rename to references/behat-steps/when-i-run-try-from.md diff --git a/behat-steps/when-i-run-try-the-previous-command-again.md b/references/behat-steps/when-i-run-try-the-previous-command-again.md similarity index 100% rename from behat-steps/when-i-run-try-the-previous-command-again.md rename to references/behat-steps/when-i-run-try-the-previous-command-again.md diff --git a/behat-steps/when-i-run-try.md b/references/behat-steps/when-i-run-try.md similarity index 100% rename from behat-steps/when-i-run-try.md rename to references/behat-steps/when-i-run-try.md diff --git a/config.md b/references/config.md similarity index 100% rename from config.md rename to references/config.md diff --git a/documentation-standards.md b/references/documentation-standards.md similarity index 100% rename from documentation-standards.md rename to references/documentation-standards.md diff --git a/hosting-companies.md b/references/hosting-companies.md similarity index 100% rename from hosting-companies.md rename to references/hosting-companies.md diff --git a/internal-api.md b/references/internal-api.md similarity index 100% rename from internal-api.md rename to references/internal-api.md diff --git a/internal-api/wp-cli-add-command.md b/references/internal-api/wp-cli-add-command.md similarity index 100% rename from internal-api/wp-cli-add-command.md rename to references/internal-api/wp-cli-add-command.md diff --git a/internal-api/wp-cli-add-hook.md b/references/internal-api/wp-cli-add-hook.md similarity index 100% rename from internal-api/wp-cli-add-hook.md rename to references/internal-api/wp-cli-add-hook.md diff --git a/internal-api/wp-cli-add-wp-hook.md b/references/internal-api/wp-cli-add-wp-hook.md similarity index 100% rename from internal-api/wp-cli-add-wp-hook.md rename to references/internal-api/wp-cli-add-wp-hook.md diff --git a/internal-api/wp-cli-colorize.md b/references/internal-api/wp-cli-colorize.md similarity index 100% rename from internal-api/wp-cli-colorize.md rename to references/internal-api/wp-cli-colorize.md diff --git a/internal-api/wp-cli-confirm.md b/references/internal-api/wp-cli-confirm.md similarity index 100% rename from internal-api/wp-cli-confirm.md rename to references/internal-api/wp-cli-confirm.md diff --git a/internal-api/wp-cli-debug.md b/references/internal-api/wp-cli-debug.md similarity index 100% rename from internal-api/wp-cli-debug.md rename to references/internal-api/wp-cli-debug.md diff --git a/internal-api/wp-cli-do-hook.md b/references/internal-api/wp-cli-do-hook.md similarity index 100% rename from internal-api/wp-cli-do-hook.md rename to references/internal-api/wp-cli-do-hook.md diff --git a/internal-api/wp-cli-error-multi-line.md b/references/internal-api/wp-cli-error-multi-line.md similarity index 100% rename from internal-api/wp-cli-error-multi-line.md rename to references/internal-api/wp-cli-error-multi-line.md diff --git a/internal-api/wp-cli-error.md b/references/internal-api/wp-cli-error.md similarity index 100% rename from internal-api/wp-cli-error.md rename to references/internal-api/wp-cli-error.md diff --git a/internal-api/wp-cli-get-config.md b/references/internal-api/wp-cli-get-config.md similarity index 100% rename from internal-api/wp-cli-get-config.md rename to references/internal-api/wp-cli-get-config.md diff --git a/internal-api/wp-cli-get-php-binary.md b/references/internal-api/wp-cli-get-php-binary.md similarity index 100% rename from internal-api/wp-cli-get-php-binary.md rename to references/internal-api/wp-cli-get-php-binary.md diff --git a/internal-api/wp-cli-halt.md b/references/internal-api/wp-cli-halt.md similarity index 100% rename from internal-api/wp-cli-halt.md rename to references/internal-api/wp-cli-halt.md diff --git a/internal-api/wp-cli-has-config.md b/references/internal-api/wp-cli-has-config.md similarity index 100% rename from internal-api/wp-cli-has-config.md rename to references/internal-api/wp-cli-has-config.md diff --git a/internal-api/wp-cli-launch-self.md b/references/internal-api/wp-cli-launch-self.md similarity index 100% rename from internal-api/wp-cli-launch-self.md rename to references/internal-api/wp-cli-launch-self.md diff --git a/internal-api/wp-cli-launch.md b/references/internal-api/wp-cli-launch.md similarity index 100% rename from internal-api/wp-cli-launch.md rename to references/internal-api/wp-cli-launch.md diff --git a/internal-api/wp-cli-line.md b/references/internal-api/wp-cli-line.md similarity index 100% rename from internal-api/wp-cli-line.md rename to references/internal-api/wp-cli-line.md diff --git a/internal-api/wp-cli-log.md b/references/internal-api/wp-cli-log.md similarity index 100% rename from internal-api/wp-cli-log.md rename to references/internal-api/wp-cli-log.md diff --git a/internal-api/wp-cli-read-value.md b/references/internal-api/wp-cli-read-value.md similarity index 100% rename from internal-api/wp-cli-read-value.md rename to references/internal-api/wp-cli-read-value.md diff --git a/internal-api/wp-cli-run-command.md b/references/internal-api/wp-cli-run-command.md similarity index 100% rename from internal-api/wp-cli-run-command.md rename to references/internal-api/wp-cli-run-command.md diff --git a/internal-api/wp-cli-runcommand.md b/references/internal-api/wp-cli-runcommand.md similarity index 100% rename from internal-api/wp-cli-runcommand.md rename to references/internal-api/wp-cli-runcommand.md diff --git a/internal-api/wp-cli-success.md b/references/internal-api/wp-cli-success.md similarity index 100% rename from internal-api/wp-cli-success.md rename to references/internal-api/wp-cli-success.md diff --git a/internal-api/wp-cli-utils-basename.md b/references/internal-api/wp-cli-utils-basename.md similarity index 100% rename from internal-api/wp-cli-utils-basename.md rename to references/internal-api/wp-cli-utils-basename.md diff --git a/internal-api/wp-cli-utils-esc-like.md b/references/internal-api/wp-cli-utils-esc-like.md similarity index 100% rename from internal-api/wp-cli-utils-esc-like.md rename to references/internal-api/wp-cli-utils-esc-like.md diff --git a/internal-api/wp-cli-utils-format-items.md b/references/internal-api/wp-cli-utils-format-items.md similarity index 100% rename from internal-api/wp-cli-utils-format-items.md rename to references/internal-api/wp-cli-utils-format-items.md diff --git a/internal-api/wp-cli-utils-get-flag-value.md b/references/internal-api/wp-cli-utils-get-flag-value.md similarity index 100% rename from internal-api/wp-cli-utils-get-flag-value.md rename to references/internal-api/wp-cli-utils-get-flag-value.md diff --git a/internal-api/wp-cli-utils-get-home-dir.md b/references/internal-api/wp-cli-utils-get-home-dir.md similarity index 100% rename from internal-api/wp-cli-utils-get-home-dir.md rename to references/internal-api/wp-cli-utils-get-home-dir.md diff --git a/internal-api/wp-cli-utils-get-named-sem-ver.md b/references/internal-api/wp-cli-utils-get-named-sem-ver.md similarity index 100% rename from internal-api/wp-cli-utils-get-named-sem-ver.md rename to references/internal-api/wp-cli-utils-get-named-sem-ver.md diff --git a/internal-api/wp-cli-utils-get-php-binary.md b/references/internal-api/wp-cli-utils-get-php-binary.md similarity index 100% rename from internal-api/wp-cli-utils-get-php-binary.md rename to references/internal-api/wp-cli-utils-get-php-binary.md diff --git a/internal-api/wp-cli-utils-get-temp-dir.md b/references/internal-api/wp-cli-utils-get-temp-dir.md similarity index 100% rename from internal-api/wp-cli-utils-get-temp-dir.md rename to references/internal-api/wp-cli-utils-get-temp-dir.md diff --git a/internal-api/wp-cli-utils-http-request.md b/references/internal-api/wp-cli-utils-http-request.md similarity index 100% rename from internal-api/wp-cli-utils-http-request.md rename to references/internal-api/wp-cli-utils-http-request.md diff --git a/internal-api/wp-cli-utils-ispiped.md b/references/internal-api/wp-cli-utils-ispiped.md similarity index 100% rename from internal-api/wp-cli-utils-ispiped.md rename to references/internal-api/wp-cli-utils-ispiped.md diff --git a/internal-api/wp-cli-utils-launch-editor-for-input.md b/references/internal-api/wp-cli-utils-launch-editor-for-input.md similarity index 100% rename from internal-api/wp-cli-utils-launch-editor-for-input.md rename to references/internal-api/wp-cli-utils-launch-editor-for-input.md diff --git a/internal-api/wp-cli-utils-make-progress-bar.md b/references/internal-api/wp-cli-utils-make-progress-bar.md similarity index 100% rename from internal-api/wp-cli-utils-make-progress-bar.md rename to references/internal-api/wp-cli-utils-make-progress-bar.md diff --git a/internal-api/wp-cli-utils-normalize-path.md b/references/internal-api/wp-cli-utils-normalize-path.md similarity index 100% rename from internal-api/wp-cli-utils-normalize-path.md rename to references/internal-api/wp-cli-utils-normalize-path.md diff --git a/internal-api/wp-cli-utils-parse-ssh-url.md b/references/internal-api/wp-cli-utils-parse-ssh-url.md similarity index 100% rename from internal-api/wp-cli-utils-parse-ssh-url.md rename to references/internal-api/wp-cli-utils-parse-ssh-url.md diff --git a/internal-api/wp-cli-utils-parse-str-to-argv.md b/references/internal-api/wp-cli-utils-parse-str-to-argv.md similarity index 100% rename from internal-api/wp-cli-utils-parse-str-to-argv.md rename to references/internal-api/wp-cli-utils-parse-str-to-argv.md diff --git a/internal-api/wp-cli-utils-proc-open-compat.md b/references/internal-api/wp-cli-utils-proc-open-compat.md similarity index 100% rename from internal-api/wp-cli-utils-proc-open-compat.md rename to references/internal-api/wp-cli-utils-proc-open-compat.md diff --git a/internal-api/wp-cli-utils-report-batch-operation-results.md b/references/internal-api/wp-cli-utils-report-batch-operation-results.md similarity index 100% rename from internal-api/wp-cli-utils-report-batch-operation-results.md rename to references/internal-api/wp-cli-utils-report-batch-operation-results.md diff --git a/internal-api/wp-cli-utils-trailingslashit.md b/references/internal-api/wp-cli-utils-trailingslashit.md similarity index 100% rename from internal-api/wp-cli-utils-trailingslashit.md rename to references/internal-api/wp-cli-utils-trailingslashit.md diff --git a/internal-api/wp-cli-utils-write-csv.md b/references/internal-api/wp-cli-utils-write-csv.md similarity index 100% rename from internal-api/wp-cli-utils-write-csv.md rename to references/internal-api/wp-cli-utils-write-csv.md diff --git a/internal-api/wp-cli-warning.md b/references/internal-api/wp-cli-warning.md similarity index 100% rename from internal-api/wp-cli-warning.md rename to references/internal-api/wp-cli-warning.md diff --git a/shell-friends.md b/references/shell-friends.md similarity index 100% rename from shell-friends.md rename to references/shell-friends.md diff --git a/tools.md b/references/tools.md similarity index 100% rename from tools.md rename to references/tools.md