Skip to content

Conversation

@kraftbj
Copy link
Contributor

@kraftbj kraftbj commented Jan 7, 2026

Fixes #

Proposed changes:

  • Fix environment checker output descriptions to match actual script output
  • quick-start.md: Change "YES or OK" to "ok or yes", "NO" to "no"
  • development-environment.md: Change "SUCCESS" to "ok or yes", "FAILED" to "no"

The actual output of tools/check-development-environment.sh uses lowercase ok, yes, and no.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable?

Jetpack product discussion

N/A - Documentation fix

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • Run tools/check-development-environment.sh and verify the output uses lowercase ok, yes, and no
  • Review the updated descriptions in docs/quick-start.md and docs/development-environment.md

Match the actual output format of tools/check-development-environment.sh:
- quick-start.md: Change "YES or OK" to "ok or yes", "NO" to "no"
- development-environment.md: Change "SUCCESS" to "ok or yes", "FAILED" to "no"
Copilot AI review requested due to automatic review settings January 7, 2026 18:35
@kraftbj kraftbj added [Status] Needs Review This PR is ready for review. [Type] Janitorial Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. labels Jan 7, 2026
@kraftbj kraftbj self-assigned this Jan 7, 2026
@kraftbj kraftbj requested a review from a team January 7, 2026 18:35
@github-actions github-actions bot added the Docs label Jan 7, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes documentation inaccuracies in the environment checker output descriptions. The actual tools/check-development-environment.sh script uses lowercase messages (ok, yes, no), but the documentation incorrectly referenced uppercase variations (YES, OK, NO, SUCCESS, FAILED).

  • Updated message references from uppercase to lowercase to match actual script output
  • Applied changes consistently across both quick-start and development-environment documentation files

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/quick-start.md Changed YES or OK to ok or yes and NO to no in environment checker output descriptions
docs/development-environment.md Changed SUCCESS to ok or yes and FAILED to no in environment checker output descriptions, also fixed grammar from "detect" to "detects"

Copilot AI review requested due to automatic review settings January 8, 2026 17:21
@kraftbj kraftbj requested a review from anomiex January 8, 2026 17:22
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 8, 2026 18:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings January 8, 2026 18:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@kraftbj kraftbj merged commit 7d4c2df into trunk Jan 8, 2026
66 checks passed
@kraftbj kraftbj deleted the fix/docs-env-checker-output branch January 8, 2026 18:19
@github-actions github-actions bot removed the [Status] Needs Review This PR is ready for review. label Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. [Type] Janitorial

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants