Skip to content

Document MyYoast OAuth client CLI commands#391

Open
diedexx wants to merge 3 commits intomainfrom
oauth-23130
Open

Document MyYoast OAuth client CLI commands#391
diedexx wants to merge 3 commits intomainfrom
oauth-23130

Conversation

@diedexx
Copy link
Copy Markdown
Member

@diedexx diedexx commented Apr 28, 2026

Fixes #

Summary

Adds developer-portal coverage for the MyYoast OAuth/OIDC client introduced in Yoast/wordpress-seo#23130. The connection module is gated behind a YOAST_SEO_MYYOAST_CONNECTION feature flag and ships no UI yet, but the wp yoast auth WP CLI namespace is publicly observable today and warrants documentation.

One new page and the corresponding sidebar entry:

  • features/wp-cli/auth — reference for the wp yoast auth namespace, covering all subcommands: status, register, verify, deregister, authorize, revoke, and rotate-keys. Mentions the feature-flag requirement up front so readers don't waste time on a missing command.

Relevant technical choices

  • One CLI page covering all subcommands: mirrors features/wp-cli/reindex-indexables.md, which similarly covers all flags of wp yoast index on a single page.
  • No _redirects entries needed: the URL is new.
  • No changelog entry: the upstream PR is labeled changelog: non-user-facing and is feature-flagged off.

Test instructions

This PR can be acceptance tested by following these steps:

  1. Pull the branch and run yarn to install dependencies, then yarn build to confirm the site builds without broken-link errors.
  2. Run yarn start --no-open and visit:
    • http://localhost:3000/features/wp-cli/auth/ — page renders, sidebar entry "MyYoast authentication" appears under Yoast SEO features → WP CLI.
  3. On the CLI page, verify the :::caution Requires the MyYoast connection feature flag admonition renders correctly (yellow caution box, define( 'YOAST_SEO_MYYOAST_CONNECTION', true ); in a fenced PHP block inside it). Confirm all seven subcommands are listed (status, register, verify, deregister, authorize, revoke, rotate-keys).
  4. External RFC links (RFC 7591, RFC 7636, RFC 9449) and the wp-cli.org link should all open the correct external resources.

Quality assurance

  • Security - I have thought about any security implications this code might add.
  • Performance - I have checked that this code doesn't impact performance (greatly).
  • Caching - I have analyzed the caching methods that this code touches and have added instructions to deal with those.
  • Tested - I have tested this code to the best of my abilities.
  • Automated tests - I have added unit tests to verify the code works as intended.
  • Testability - I have added unique ids to elements, so they can be located in automated testing.
  • I have altered a filename.
    • I have adjusted the ID property accordingly and updated all internal links.
    • I have added the redirect to the _redirects file in the root of the project.

Adds developer-portal coverage for the MyYoast OAuth client introduced
in Yoast/wordpress-seo#23130:

- features/wp-cli/auth: reference for the `wp yoast auth` namespace
  (status, register, verify, deregister, authorize, revoke,
  rotate-keys), gated behind YOAST_SEO_MYYOAST_CONNECTION.
- customization/yoast-seo/filters/myyoast-oauth-filters: covers the
  three issuer-config filters (issuer URL, software statement, initial
  access token), framed as overrides for non-production issuers.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@diedexx diedexx added the documentation Improvements or additions to documentation label Apr 28, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 28, 2026

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2176066
Status: ✅  Deploy successful!
Preview URL: https://1e7d604b.yoast-developer.pages.dev
Branch Preview URL: https://oauth-23130.yoast-developer.pages.dev

View logs

Upstream Yoast/wordpress-seo#23130 renamed the three issuer-config
filters from `Yoast\WP\SEO\myyoast_*` to `wpseo_myyoast_*`. Update the
documentation page and code samples to match.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@diedexx diedexx changed the title Document MyYoast OAuth client CLI commands and configuration filters Document MyYoast OAuth client CLI commands Apr 29, 2026
The three filters (wpseo_myyoast_issuer_url, wpseo_myyoast_software_statement,
wpseo_myyoast_initial_access_token) are an internal escape hatch for pointing
the client at non-production issuers and require credentials only Yoast can
issue. Not appropriate for the public developer portal.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant