Documenting the "vendor expose" sorcery
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- php
- Área
- documentation
Línea de trabajo
Start by locating the existing vendor-expose documentation and implementation references in the SilverStripe project. Map the workflow for project and module resources, template and PHP references, and common debugging cases. Done means a central article covers each acceptance criterion for both developers and module developers.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Affected Version
4 and above
Description
Following some discussion it appears the "vendor expose" process is not super clear for most of the SilverStripe community.
I suggest we fix this by providing a central doc article demystifying the vendor-expose logic.
Acceptance criteria
- As a SilverStripe Developer I can understand:
- The purpose of "vendor-expose",
- How to expose my project resources,
- How to reference project resources and module resources in templates and php files,
- How to debug common issues with vendor expose
- As a SilverStripe Module Developer I can understand:
- How to expose my module's resources and reference them.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 7
- Forks
- 75
- Merge medio
- 1 d 12 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de silverstripe/developer-docs
-
6.0.0 changelog: DBField formatters on array getters now render emptyPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
silverstripe/developer-docs#912 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rulesAbiertoaffects/v6 complexity/low impact/low type/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
silverstripe/developer-docs#909 · 1 comentario ·
-
affects/v6 complexity/low impact/low type/docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
silverstripe/developer-docs#908 · 1 comentario ·
-
affects/v5 affects/v6 complexity/low impact/low type/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
silverstripe/developer-docs#907 · 1 comentario ·
Todos los issues de silverstripe/developer-docs
Issues similares
-
[TASK] Document technology stackAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
chingu-voyages/V62-tier3-team-33#285 ·
Los mantenedores suelen responder en 1 día
-
automated issue report
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
lirantal/discoprint#36 ·
Los mantenedores suelen responder en 1 día
-
accepting PR Content:HTML
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
mdn/content#45988 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[Doc Gap] Document new --enable-public-network-access breaking change for azurebackup vault createAbiertocopilot documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día