Advanced blueprint.json code block incomplete

[flexseth]

Reported from Slack, there are duplicates of this issue across various repos I can work to get closed out once the PR is merged. If not merged, and automatic syncing happens at some point, the changes will be reverted

Otherwise this is fixed but I'll keep the issue open until it's addressed across the board

I found a bug in this docs. In this article, the code block is unfinished: https://developer.wordpress.org/plugins/wordpress-org/previews-and-blueprints/#blueprints

Link to doc in question

Second blueprint on the page

Here’s an example of a more advanced blueprint.json that demonstrates some more features you could use to create a rich demo environment for users:

{
    "landingPage": "/wp-admin/post.php?post=5&action=edit",
    "preferredVersions": {
        "php": "7.4",
        "wp": "5.9"
    },
    "phpExtensionBundles": [
        "kitchen-sink"
    ],
    "steps": [
        {
            "step": "login",
            "username": "admin",
            "password": "password"
        },
        {
            "step": "installPlugin",
            "pluginZipFile": {
                "resource": "wordpress.org\/plugins",
                "slug": "my-imaginary-plugin-dependency"
            },
            "options": {
                "activate": true
            }
        },
        {
            "step": "installPlugin",
            "pluginZipFile": {
                "resource": "wordpress.org\/plugins",
                "slug": "my-imaginary-plugin"
            },
            "options": {
                "activate": true
            }
        },
        {
            "step": "installTheme",
            "themeZipFile": {
                "resource": "wordpress.org\/themes",
                "slug": "my-imaginary-theme"
            }
        },
        {
            "step": "setSiteOptions",
            "options": {
                "some_required_option_1": "your_favorite_values",
                "some_required_option_2": "your_favorite_values"
            }
        },
        {
            "step": "runPHP",
            "code": " 5,\n'post_title' => 'Example Post',\n'post_content' => '

[adamziel]

Thank you for surfacing this here! I reported this on meta.trac.wordpress.org where that page is discussed: https://meta.trac.wordpress.org/ticket/7487#comment:6

[theMikeD]

This change was made to the Plugin Handbook.

[adamziel]

Looks good on my end – closing this issue.

[adamziel]

@flexseth said:

The PR in this issue needs to be merged, so when the handbook auto-syncs, the change I made isn't overwritten

Let's keep this issue open until that happens.

[colorful-tones]

@flexseth I'm not privy to the auto-sync that needs to happen or where/how that happens. Thanks for getting this all wrangled together. I wanted to see if the auto-sync happened or if there is anything I can do (or ping) to close this out.

[flexseth]

@flexseth I'm not privy to the auto-sync that needs to happen or where/how that happens.

Some of the handbooks sync SVN to the WordPress.org websites. The code I submitted had been manually updated, but if the PR wasn't merged, the sync would overwrite the changes that were correct on the Plugins Handbook on wp.org

Everything sync'd automatically until recent, but it's paused while discussion goes on around a better workflow for the handbooks

For now I think @adamziel wants to keep the issue open for posterity! Hopefully really soon there will be a proof of concept for how a handbook can look with Playground

[colorful-tones]

Really appreciate the additional context @flexseth 🤘

[flexseth]

Let's keep this issue open until that happens.

Got it done. Marking as closed!