既存プラグインを入れる・止める・外す

管理画面から入れるプラグインと、制作担当者がコードへ組み込むものを分け、導入・停止・削除を説明します。

目次

プラグインは、サイトに機能を足す部品です。導入方法には、管理画面から入れる方法と、制作担当者がコードへ組み込む方法があります。使いたいプラグインがどちらに対応しているかを、先に確かめます。

たとえば「週末ノートへ、記事の保存を知らせる機能を足したい」という場面です。編集担当者は目的を決め、管理者と制作担当者が導入方法を選びます。必要な権限がなければ、管理者へ依頼するところまでで大丈夫です。

どちらの導入方法かを知る

方法主に作業する人変更する場所
Registryから導入権限を持つ管理者EmDashの管理画面
npmで組み込む制作担当者パッケージとサイトの設定ファイル

Registryは配布されたプラグインを探す場所です。npmはコードの部品を取り寄せる道具です。npmで設定管理するものは、管理画面から同じように追加・削除できるとは限りません。公式の導入方法(別タブで開く)

導入前に、目的と戻し方を決める

「何ができれば成功か」を一つ書きます。たとえば「記事保存後にテスト先へ通知する」です。制作担当者には、対応するEmDashの版、保存場所、実行環境、追加費用の有無を確認してもらいます。

サンドボックス形式は、制限された環境で動く方式です。その実行環境が用意されていなければ、部品だけ入れても動きません。最初は本番と分けた検証環境で試します。

Registryから入れる流れ

管理者がEmDash管理画面の Registry(配布プラグインを探す場所)を開き、部品を検索して詳細を見ます。作者、版、要求する権限を確認して Install(導入)を選び、確認画面の内容を読んで進めます。

「記事を読む権限」と「記事を書き換える権限」は違います。通知だけが目的なのに削除も必要なのかなど、用途と照合してください。配布物の署名を確認する仕組みや、ほかの処理から分けて動かす仕組みがあっても、許可した操作まで無害と保証されるわけではありません。権限の確認

導入後は Plugins(導入したプラグインの管理)で必要な設定を入れ、テスト記事を1件使って結果を確認します。目的の処理が行われ、想定外の送信や変更がないことまで確認できたら、導入の確認は完了です。

一時停止と削除を分ける

調査のために止めるなら、Pluginsで無効化できるか確認します。止めた後、公開ページと編集画面を開いて影響を見ます。

削除する場合は Uninstall(取り外し)を選びます。公式手順では、保存データは既定で残り、Also delete plugin storage data(保存データも削除する)を選ぶとそのデータも削除します。再導入で使う可能性があるかを先に判断してください。

部品のコードを外すこと、保存データを消すこと、記事内の表示部品を消すことは同じではありません。過去の記事がそのプラグインの表示機能を使っている場合は、代わりの表示を用意してから外します。表示部品の確認

Registryは見えるのに導入できない場合もあります。管理権限、ダウンロードした部品の保存先、部品を動かす仕組みの準備を制作担当者へ確認します。表示されたエラーを控え、同じ導入操作を繰り返す前に原因を調べてもらいましょう。

制作担当者へ渡す記録

名称、版、導入方法、設定担当者、テストした内容、停止時の影響を残します。npm方式なら、制作担当者が使うパッケージと設定を変更し、公開用ファイルを作り直して再公開します。管理画面に削除ボタンがない場合は、制作担当者へ取り外しを依頼してください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。