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

クローズ 初心者向け
  • 何か問題がありますか？
#308 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
90/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
yaml
領域
documentation

調査の方向性

まず content/4.api/ のバンドル設定リファレンスから、ユーザーのメール設定を確認します。silverback_api_components.emails.logo と logo_width を、デフォルト値、Twig パスの動作、正の整数の制約、および website_name の代替テキスト変更を含めて追加します。設定例を更新し、生成されたリファレンスが他のバンドル設定と一致することを確認してください。

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
TypeScript
スター
0
フォーク
0
平均マージ
1時間 20分
マージ済み PR（30日）
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。