Skip to content

Commit e4b8b85

Browse files
docs: fix documentation audit issues and update references (#663)
Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com>
1 parent e01cbb1 commit e4b8b85

16 files changed

Lines changed: 41 additions & 46 deletions

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (C) 2012-2022 WP-CLI Development Group (https://github.com/wp-cli/handbook/contributors)
3+
Copyright (C) 2012-2026 WP-CLI Development Group (https://github.com/wp-cli/handbook/contributors)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎contributions/committers-credo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Practically-speaking:
2020

2121
## Stellar judgement
2222

23-
A great product is a reflection of thoughtful, deliberate, and considered decision-making. WP-CLI committers exhibit stellar judgement with making decisions on new features, fixing bugs, merging others pull requests, and generally working on the project.
23+
A great product is a reflection of thoughtful, deliberate, and considered decision-making. WP-CLI committers exhibit stellar judgement when making decisions on new features, fixing bugs, merging others' pull requests, and generally working on the project.
2424

2525
The basis of this decision-making ensures:
2626

‎contributions/pull-requests.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ If you haven't submitted a pull request before, you'll want to install WP-CLI fo
6262
4. Install all Composer dependencies: `composer install`
6363
5. Verify WP-CLI was installed properly: `vendor/bin/wp --info`
6464

65-
Within this package, you should preferably use `vendor/bin/wp` to run the command. Just using `wp` should work as well, but by doing that you might run the command through a different version of the framework and thus getting an unexpected result.
65+
Within this package, you should preferably use `vendor/bin/wp` to run the command. Just using `wp` should work as well, but by doing that you might run the command through a different version of the framework and thus get an unexpected result.
6666

6767
### Working on the project as a whole
6868

@@ -192,7 +192,7 @@ To run the unit tests, execute:
192192

193193
To run a specific unit test, you can use:
194194

195-
composer phpunit -- filter=<method name>
195+
composer phpunit -- --filter=<method name>
196196

197197
### Running all tests in one go
198198

‎contributions/release-checklist.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Release Checklist
22

3-
There are two different release checklists available from within the [`
4-
wp-cli/wp-cli`
5-
](https://github.com/wp-cli/wp-cli) repository:
3+
There are two different release checklists available from within the [`wp-cli/wp-cli`](https://github.com/wp-cli/wp-cli) repository:
64

75
* Generate a [🚀 Regular Release Checklist](https://github.com/wp-cli/wp-cli/issues/new?assignees=schlessera&labels=i%3A+scope%3Adistribution&template=4-REGULAR_RELEASE_CHECKLIST.md&title=Release+checklist+for+v2.x.x) - applies to major (2.x.x) and minor (x.1.x) releases.
86
* Generate a [🔧 Patch Release Checklist](https://github.com/wp-cli/wp-cli/issues/new?assignees=schlessera&labels=i%3A+scope%3Adistribution&template=5-PATCH_RELEASE_CHECKLIST.md&title=Release+checklist+for+v2.x.x) - applies to patch (x.x.1) releases only.

‎contributions/repository-management.md‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,13 @@ Labels can be part of a label group, a concept that is applicable to all package
4040

4141
#### Command
4242

43-
The labels that define what exact command a given issue/pull request applies to are prefixed with `command:`
43+
The labels that define what specific command a given issue/pull request is related to are prefixed with `command:`.
4444

45-
_Example: `command:cli-update`_
45+
Some examples:
46+
47+
* `command:core` - Relates to one or more of the subcommands under the `wp core` parent command.
48+
* `command:cli-check-update` - Relates to the `wp cli check-update` command.
49+
* `command:post-meta-update` - Relates to the `wp post meta update` command.
4650

4751
#### Scope
4852

@@ -59,23 +63,13 @@ Used scopes:
5963

6064
#### State
6165

62-
The labels that defined what state a given issue/pull request is in are prefixed with `state:`.
66+
The labels that define what state a given issue/pull request is in are prefixed with `state:`.
6367

6468
Used states:
6569

6670
* `state:unconfirmed` - The bug/problem in the issue could not be replicated yet or might be related to the reporter's environment.
6771
* `state:unsupported` - The issue is outside of the scope of a bug report and cannot be supported on GitHub. The reporter should be pointed towards one of the [support channels](https://make.wordpress.org/cli/handbook/support/).
6872

69-
#### Command
70-
71-
The labels that define what specific command a given issue/pull request is related to are prefixed with `command:`.
72-
73-
Some examples:
74-
75-
* `command:core` - Relates to one or more of the subcommands under the `wp core` parent command.
76-
* `command:cli-check-update` - Relates to the `wp cli check-update` command.
77-
* `command:post-meta-update` - Relates to the `wp post-meta update` command.
78-
7973
### Required Labels
8074

8175
Some labels have a special meaning and/or might be used for automated workflows down the road. These are required across all official packages.
@@ -98,7 +92,7 @@ Good first issues are small in scope and don't require extensive technical exper
9892

9993
## Commits
10094

101-
No direct commits are to be done against the default branch (`main`/`master`) branch of the packages. All code changes need to go through a pull request workflow.
95+
No direct commits are to be done against the default (`main`/`master`) branch of the packages. All code changes need to go through a pull request workflow.
10296

10397
## Pull Requests
10498

‎contributions/security-vulnerability-reporting.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ This includes weaknesses where the fix would:
7575
- Remove or restrict a documented feature
7676
- Impose significant complexity in order to fix a vulnerability that requires implausible preconditions
7777

78-
Such fixes may do more harm than the issue it addresses. Where the downside of fixing such an issue exceeds the vulnerability's impact, the team may instead choose to clearly document the behavior.
78+
Such fixes may do more harm than the issue they address. Where the downside of fixing such an issue exceeds the vulnerability's impact, the team may instead choose to clearly document the behavior.
7979

8080
## If your report still stands
8181

‎guides.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* **[Common issues and their fixes](https://make.wordpress.org/cli/handbook/guides/common-issues/)** - In case of fire, break glass.
99
* **[External resources](https://make.wordpress.org/cli/handbook/guides/external-resources/)** - Blog posts, slides and videos from users.
1010
* **[Force output to a specific locale](https://make.wordpress.org/cli/handbook/guides/force-output-specific-locale/)** - Localisation issue
11-
* **[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advise
11+
* **[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advice
1212
* **[Installing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/installing-packages/)** - Learn how to install packages and use version constraints
1313
* **[Sharing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/sharing-wp-cli-packages/)** - Some words about your environment
1414
* **[Troubleshooting Guide](https://make.wordpress.org/cli/handbook/guides/troubleshooting/)** - Some help to troubleshoot

‎guides/behat-tests.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Stability between releases is an important contract WP-CLI makes with its users.
2121

2222
### Getting Started
2323

24-
Every WP-CLI repository with commands has a `features/` directory containing one or more YAML-formatted `*.feature` files.
24+
Every WP-CLI repository with commands has a `features/` directory containing one or more Gherkin-formatted `*.feature` files.
2525

2626
## Writing Your First Test
2727

‎guides/commands-cookbook.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Packages are to WP-CLI as plugins are to WordPress. There are distinct differenc
1616

1717
Bundled commands:
1818

19-
* Usually cover functionality offered by a standard install WordPress. There are exceptions to this rule though, notably `wp search-replace` ([doc](https://developer.wordpress.org/cli/commands/search-replace/)).
19+
* Usually cover functionality offered by a standard WordPress installation. There are exceptions to this rule though, notably `wp search-replace` ([doc](https://developer.wordpress.org/cli/commands/search-replace/)).
2020
* Do not depend on other components such as plugins, themes etc.
2121
* Are maintained by the WP-CLI team.
2222

@@ -62,7 +62,7 @@ WP_CLI::add_command( 'foo', 'foo_command' );
6262
// 2. Command is a closure
6363
$foo_command = function( $args ) {
6464
WP_CLI::success( $args[0] );
65-
}
65+
};
6666
WP_CLI::add_command( 'foo', $foo_command );
6767
6868
// 3. Command is a method on a class
@@ -284,7 +284,7 @@ The `---` block after a parameter description allows you to set extra metadata f
284284
The longdesc is also displayed when calling the `help` command, for example, `wp help example hello`. Its syntax is [Markdown Extra](http://michelf.ca/projects/php-markdown/extra/) and here are a few more notes on how it's handled by WP-CLI:
285285

286286
* The longdesc is generally treated as a free-form text. The `OPTIONS` and `EXAMPLES` section names are not enforced, just common and recommended.
287-
* Sections names (`## NAME`) are colorized and printed with zero indentation.
287+
* Section names (`## NAME`) are colorized and printed with zero indentation.
288288
* Everything else is indented by 2 characters, option descriptions are further indented by additional 2 characters.
289289
* Word-wrapping is a bit tricky. If you want to utilize as much space on each line as possible and don't get word-wrapping artifacts like one or two words on the next line, follow these rules:
290290
* Hard-wrap option descriptions at **75 chars** after the colon and a space.
@@ -437,7 +437,7 @@ function hello( $args, $assoc_args ) {
437437
}
438438
```
439439

440-
`$args` variable will store all the positional arguments:
440+
The `$args` variable will store all the positional arguments:
441441

442442
```
443443
$ wp example hello Joe Doe
@@ -448,7 +448,7 @@ WP_CLI::line( $args[0] ); // Joe
448448
WP_CLI::line( $args[1] ); // Doe
449449
```
450450

451-
`$assoc_args` variable will store all the arguments defined like `--key=value` or `--flag` or `--no-flag`
451+
The `$assoc_args` variable will store all the arguments defined like `--key=value` or `--flag` or `--no-flag`:
452452

453453
```
454454
$ wp example hello --name='Joe Doe' --verbose --no-option
@@ -626,7 +626,7 @@ Both approaches are valid. Use the `WP_CLI` constant check when you need to cond
626626

627627
### Distribute as a stand-alone command
628628

629-
Standalone WP-CLI commands can be installed from any git repository, ZIP file or folder. The only technical requirement is to include a valid composer.json file with an autoload declaration. We recommended including `"type": "wp-cli-package"` to distinguish your project explicitly as a WP-CLI package.
629+
Standalone WP-CLI commands can be installed from any git repository, ZIP file or folder. The only technical requirement is to include a valid composer.json file with an autoload declaration. We recommend including `"type": "wp-cli-package"` to distinguish your project explicitly as a WP-CLI package.
630630

631631
Here's a full composer.json example from the server command:
632632

@@ -656,7 +656,7 @@ Here's a full composer.json example from the server command:
656656

657657
Note the `autoload` declaration, which loads `command.php`.
658658

659-
Once you've added a valid composer.json file to your project repository, WP-CLI users can pull it in via the package manager from the location you opted to store it in. Here's a few examples of storage locations and the corresponding syntax of installing it via the package manager:
659+
Once you've added a valid composer.json file to your project repository, WP-CLI users can pull it in via the package manager from the location you opted to store it in. Here are a few examples of storage locations and the corresponding syntax of installing it via the package manager:
660660

661661
#### Git repository
662662

‎guides/running-commands-remotely.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ Another way to achieve this is to specify the `$PATH` in the remote machine user
166166

167167
### Remote non-interactive shell resolves aliases and runs wp as alias with php
168168

169-
Some webhosts are configured very restrictive:
170-
- They do not allow you to execute your own shellscripts, so everything from method [WP-CLI binary](#copy-wp-cli-binary-to-home-bin) fails.
169+
Some web hosts are configured very restrictively:
170+
- They do not allow you to execute your own shell scripts, so everything from method [WP-CLI binary](#copy-wp-cli-binary-to-home-bin) fails.
171171
- `sshd` is configured with `PermitUserEnvironment=no`, so customizing [~/.ssh/environment](#specify-the-path-in-home-ssh-environment) has no effect and fails too.
172172
- Also [using the before_ssh hook on the client machine](#using-before_ssh-hook-on-client-machine) will not help you, as in all cases you cannot run `wp` on the remote.
173173

0 commit comments

Comments
 (0)