テーマのファイルをGuideからエクスポートし、お気に入りのテキストエディタでオフラインで編集作業をすることができます。変更をプレビューするたびに、zipされたファイルがGuideにインポートされないようにするには、Zendesk Apps Tool（ZAT）を使用し、ローカルのWebブラウザで変更をプレビューします。変更結果をプレビューするには、デスクトップエディタにテーマファイルを保存し、ブラウザでページを更新します。以下の例を参考にしてください。
ZATは、Sinatraなどの開発ツールを組み合わせたものです。Sinatraはコンピュータ上でローカルに実行されるWebサーバーです。プレビューモードを開始すると、プロセスはバックグラウンドで実行されます。
この記事では、次のトピックについて説明します。
テーマのローカルプレビューを設定する
ZATをインストールして使用するには、APIアクセスを有効にし、ローカル開発環境を構築する必要があります。
テーマのローカルプレビューを設定するには
- 「管理」>「チャネル」>「API」にアクセスして、Zendesk SupportアカウントでAPIアクセスを有効にします（まだ有効にしていない場合）。
- ZATをインストールします。インストール手順については、Zendeskの開発者ドキュメントの「Installing and using ZAT」を参照してください。インストール後、こちらの手順を続行します。
- コンピューターのターミナルで次のコマンドを実行し、ZATを更新します。
gem update zendesk_apps_tools
テーマのローカルプレビューを開始する
お使いのコンピューターで、まずテーマのローカルプレビューを開始してから、テーマファイルの編集を開始します。
テーマのローカルプレビューを開始するには
- コンピューターのターミナルで、エクスポートして解凍したテーマファイルが格納されているフォルダに移動します。以下の例を参考にしてください。
cd guide_themes/newlook_theme - 次のコマンドを実行します。
zat theme preview - プロンプトに、Zendeskのサブドメインと、Zendesk Guideへのサインイン時に使用するメールアドレスとパスワードを入力します。
Guideへのサインインにシングルサインオン（SSO）を使用している場合、APIトークンを使用してサインインすることができます。REST APIのドキュメントで「API token（APIトークン）」を参照してください。ZATからサインインを求められたら、ユーザー名に「{your_email}/token」と入力します。ここで "/token"はそのまま "/token"と入力してください。パスワードにはAPIトークンを指定します。以下の例を参考にしてください。
Enter your username: jdoe@example.com/token Enter your password: e8Pvy0pvGzE8meUQxWgjIYkjrサインインに成功すると、プレビューモードが起動し、バックグラウンドで実行されます。
- 出力された"Ready"のURLをコピーし、ChromeやFirefoxなどのWebブラウザに貼り付けます。ブラウザで、HTTPとHTTPSの混在コンテンツが許容されている必要があります。Safariは混在コンテンツをサポートしておらず、テーマをローカルでプレビューすることもできません。
この例では、"Ready"のURLは「https://z3n-example.zendesk.com/hc/admin/local_preview/start」です。
このURLにアクセスすると、テーマのプレビューがロードされます。
変更結果をプレビューする
テーマプレビューモードを起動した後は、テキストエディタを使用してテーマファイルをローカルで編集することができます。テーマの開発とテストは、繰り返しの作業です。たとえば、JavaScriptにいくつか変更を加えて保存し、ブラウザのページを更新して変更をテストします。
変更結果をプレビューするには
- テキストエディタで編集したファイルを保存します。
- ブラウザのページを更新します。
プレビューが終わったら、次のいずれかの方法でプレビューモードを停止できます。
- ZATを実行しているターミナルセッションで、Ctrl+Cキーを押します。
- ブラウザのテーマプレビューページの上部にある、「プレビューを閉じる」リンクをクリックします。
0 コメント
サインインしてコメントを残してください。