基本コンセプト
いくつかの考え方が Exportelier のほぼすべてを説明します。これらが腑に落ちれば、ドキュメントの残りはすばやく読めます。
テンプレート vs. エクスポート
テンプレートは再利用可能な設計です。ドキュメントの見た目を定義するレイアウト、コンポーネント、スタイルです。エクスポートは、テンプレートを実際の Jira データに対して 1 回実行し、PDF・Word・Markdown ファイルを生成することです。テンプレートを一度設計し、そこから何度もエクスポートします。
エクスポートコンテキスト
エクスポートコンテキストは、起点となる Jira データの種類です — 単一課題、JQL 検索、ボード、スプリント、リリース、バックログ。各コンテキストは同じテンプレートエンジンに入力されます。エクスポートコンテキストを参照。
6 つの入口(課題、検索、ボード、スプリント、リリース、バックログ)を示す図またはコラージュ。
出力形式
1 つのテンプレートは 3 つの形式を生成できます:PDF、Word(DOCX)、Markdown。形式はエクスポート時に選び、テンプレートに固定されません。出力形式を参照。
レンダリングが行われる場所
すべてのレンダリングは Atlassian Forge 上で行われます。メインアプリは外部 fetch も webtrigger も宣言しないため、データが Atlassian の外に出ることはありません。これは Forge マニフェストによって強制されます。セキュリティアーキテクチャを参照。
権限
各エクスポートはあなたとして実行されます。閲覧できる課題のみをエクスポートでき、テンプレート管理は管理者のみです。権限とロールを参照。
バージョン
保存された各テンプレートは、ワンクリックで復元できるバージョンスナップショットを保持します。これとは別に、この製品はバージョン(1.0、1.1 …)で公開され、ドキュメントもそれに合わせてバージョン管理されます。バージョンスナップショットとリリースノートを参照。