Document emails.logo and emails.logo_width (bundle config)

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#308 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
90/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
yaml
Área
documentation

Línea de trabajo

Comience con la referencia de configuración del bundle en content/4.api/ y localice la configuración del correo electrónico del usuario. Añada silverback_api_components.emails.logo y logo_width, incluidos sus valores predeterminados, el comportamiento de sus rutas Twig, la restricción a enteros positivos y el cambio del texto alternativo de website_name. Actualice el ejemplo de configuración y verifique que la referencia generada coincida con los demás ajustes del bundle.

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

Descripción

The API components bundle adds config for the logo at the top of every email it sends (user emails and the orphaned resources notification): components-web-app/api-components-bundle#576 (issue components-web-app/api-components-bundle#573).

To document in the bundle configuration reference (content/4.api/), near the user email settings:

  • silverback_api_components.emails.logo: a Twig path to the image (e.g. emails/logo.png for templates/emails/logo.png, or a namespaced @App/... path). Not a filesystem path: it is embedded through Twig's email.image(). Default: the bundle's CWA logo (@SilverbackApiComponents/assets/images/email_logo.png).
  • silverback_api_components.emails.logo_width: optional width in pixels (positive integer). Set it for a 2x (retina) image so it displays at half its pixel width; null shows the image at its own width (capped by the stylesheet's max-height: 140px).
  • The logo's alt text is now the site's website_name (it was Logo).
  • This replaces the workaround of overriding templates/bundles/SilverbackApiComponentsBundle/emails/_template.html.twig and the logo image.
silverback_api_components:
    emails:
        logo: emails/logo.png
        logo_width: 200
Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
1 h 20 min
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 components-web-app/docs

Todos los issues de components-web-app/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.