Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Using multiple blueprint files (partials)

Abierto
#97 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
php
Área
tooling

Línea de trabajo

Comienza localizando el parser de blueprints y el procesamiento existente de WPCLIStep descrito en el issue, junto con el directorio assets utilizado para los archivos WXR. Define cómo se encadenarían los archivos de blueprint parciales y cómo se comportaría el paso ImportWXR propuesto; después, valida el diseño con la secuencia documentada de desarrollo de plugins.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation enhancement

The blueprint.json files offer tremendous opportunity from a scaffolding and programmatic standpoint to developers using WordPress Playground. What if it were possible to chain together multiple blueprints to create an instance?

Use case: Build Playground docs for WordPress Plugin development

I want to see all documentation tagged plugin developer

User goes to documentation, searches "develop plugins with Playground" and finds a list of all the documentation that is tagged with plugin developer.

Docs: Creating a Plugin with WordPress Playground (post_title)
Steps: (post_content) - see below - raw .json
Description: Importing multiple WXR files to build a catalog of posts (post_excerpt)

Pseudocode
  • InstallTheme schoolyard
  • LoginStep
  • ImportWXR getting-started-with-plugin-development-in-playground.wxr
  • ImportWXR understanding-plugin-headers.wxr
  • ImportWXR plugin-activation-hooks.wxr
  • ImportWXR plugin-deactivation-hooks.wxr
  • ImportWXR plugin-uninstall-hooks.wxr
  • ImportWXR plugin-security-best-practices.wxr
  • ImportWXR plugin-translation-best-practices.wxr
  • ImportWXR plugin-licensing-best-practices.wxr
  • InstallPluginStep create-plugin
  • InstallPluginStep plugin-review-check.zip
  • InstallPluginStep plugin-security-check.zip
  • ActivatePluginStep create-plugin
  • ActivatePluginStep plugin-review-check
  • ActivatePluginStep plugin-security-check
  • ImportWXR submit-plugin-for-review.wxr
  • LandingPage /

Now the user will come to the Schoolyard theme, and see the documentation for creating a plugin with WordPress Playground, with Step by Step instructions for building a WordPress Plugin.

Limitations

ImportXWR isn't implemented

Currently ImportWXR does not exist as a step in the blueprint.json file. This step could be implemented simply with a WPCLIStep and import command, and link to a WXR file in the assets directory.

Blueprint parser extended

New functionality would have to be created to chain blueprint.json files.

Creating this Step would open the door to building out documentation based on user needs in lieu of having a bunch of extra docs. For example, a new user to WordPress does not need to understand how to run Playground through a web socket.

Conclusion

Being able to chain blueprints together would open up the ability to add "partial" blueprints, which could be used modularly to build out a Playground instance.

Lenguaje dominante
PHP
Estrellas
62
Forks
23
Merge medio
4 h 12 min
PR fusionados (30 d)
1

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de WordPress/php-toolkit

Todos los issues de WordPress/php-toolkit

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.