Document the process of building assets for addons
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
Start by locating the addon development documentation and checking how it currently explains frontend assets and release workflows. Document the two approaches in the issue: committing built assets and publishing them, or building assets in GitHub Actions and distributing them with a Composer update. The work is done when addon developers can follow the documentation to choose and use either approach.
索引モデルが issue の本文から書いたものです。
説明
This question has just come up on Discord:
Does anyone have any tips on how to distribute assets for an addon? I am developing an addon that needs some js and css on the frontend to work, I created frontend assets using vite but when used with the vite tag they only work for npm run build not dev
My response was:
You can either:
- Build them manually before you tag a release and include them in the Git repository. Then, in your service provider, you can publish the files to the site's
public/vendordirectory.- A little more advanced way (which we do at Statamic, and I use for my addons), is to ignore committing assets to the repository, then building them as part of a GitHub Actions workflow used for releasing. Jason's built a package which'll then copy over the assets from the GitHub release into the site's
vendordirectory uponcomposer update.
It feels like we could do with some more detailed documentation around how addon developers should handle this.
- 主要言語
- PHP
- スター
- 133
- フォーク
- 405
- 平均マージ
- 21時間 45分
- マージ済み PR（30日）
- 12
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
statamic/docs のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
Chunked Uploadsオープン
難易度 1/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
Installation / Deployment Guides
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 40/100
メンテナーはふだん 1 日以内に返信
-
Document how conditions treat empty and null values対応中かも @joshdaugherty が 13 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 4 日以内に返信
-
Перевод устарел
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
-
Adapter: Algolia Performance
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100