Skip to content

Move DefineSiteUrlStep doc warning so it displays in docs #1245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamziel merged 1 commit into from
Apr 15, 2024
Merged

Move DefineSiteUrlStep doc warning so it displays in docs #1245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions packages/playground/blueprints/src/lib/steps/define-site-url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ import { defineWpConfigConsts } from './define-wp-config-consts';

/**
* Changes the site URL of the WordPress installation.
* Beware: Using this step makes no sense on playground.wordpress.net.
* It is useful when you're building a custom Playground-based tool like wp-now,
* or deploying Playground on a custom domain.
*
* @inheritDoc defineSiteUrl
*/
Expand All @@ -18,6 +15,10 @@ export interface DefineSiteUrlStep {
/**
* Sets WP_HOME and WP_SITEURL constants for the WordPress installation.
*
* Beware: Using this step makes no sense on playground.wordpress.net.
* It is useful when you're building a custom Playground-based tool like wp-now,
* or deploying Playground on a custom domain.
*
* @param playground The playground client.
* @param siteUrl
*/
Expand Down