Skip to content
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.

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

Understanding the "kitchen sink" PHP extension #30

Closed
2 tasks
flexseth opened this issue Apr 3, 2024 · 4 comments
Closed
2 tasks

Understanding the "kitchen sink" PHP extension #30

flexseth opened this issue Apr 3, 2024 · 4 comments

Comments

@flexseth
Copy link

flexseth commented Apr 3, 2024

  • Update docs: Pending PR (mentioned)
  • How to limit the kitchen sink - disabling PHP extensions or enabling one-by-one...?

Getting started with Blueprints

Blueprint sample

{
    "$schema": "https://playground.wordpress.net/blueprint-schema.json",
    "landingPage": "/wp-admin/",
    "preferredVersions": {
        "php": "8.0",
        "wp": "latest"
    },
    "phpExtensionBundles": ["kitchen-sink"],
    "steps": [
        {
            "step": "login",
            "username": "admin",
            "password": "password"
        }
    ]
}
@flexseth
Copy link
Author

flexseth commented Apr 3, 2024

https://wordpress.github.io/wordpress-playground/query-api/

gd, mbstring, iconv, openssl, libxml, xml, dom, simplexml, xmlreader, xmlwriter

  • Clarify: Is this all of the extensions included?
  • Discuss: Providing a brief explanation and linking out to extension info pages
  • Drill-down: Common functionality these extension libraries provide for WordPress
  • Common errors: What happens if you don't include a necessary extension? Show codes

Package explanations

Existing packages that need docs

To document (new)

fileInfo

@flexseth
Copy link
Author

flexseth commented Apr 3, 2024

@adamziel wonders if the kitchen-sink "light" option should be by default

@flexseth
Copy link
Author

flexseth commented Apr 26, 2024

  • Add links to libraries
  • Show a couple of examples of what the libraries do with WordPress - unnecessary
  • How to limit the kitchen sink - mentioned in top-level issue
  • Turn off the kitchen sink - disabled by default

Kitchen sink discussion
WordPress/wordpress-playground#1191 (comment)

@adamziel
Copy link
Owner

adamziel commented Apr 27, 2024

Let’s contain the docs discussion in this issue.

Are there more utilities? In lieu of digging through the repo and trying to figure it out, figured I'd ask here :)

Just those

Also, are these good representations what the libraries do?

No, these extensions offer many features and can be used in various ways. There’s no need to explain beyond listing them and linking out to php.net. People who need those extensions already know, and there’s no need to rewrite php docs for people who don’t need those extensions yet.

Are they all PHP extensions?

Yes

adamziel pushed a commit to WordPress/wordpress-playground that referenced this issue May 9, 2024
## What is this PR doing?
Update Blueprints API page to add more info about the `kitchen-sink` and
networking feature

## What problem is it solving?
Provides links to more information

Updated README to show that the `light` version is default

Solves issue
-
adamziel/playground-docs-workflow#30 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants