1on1 meeting guide website

このリポジトリには、guide.1on1guide.org で公開されている 1on1 meeting guide websiteの Antora playbook プロジェクトが含まれています。

デプロイ前の出力先

GitHub actionsのArtifactsとして出力されます。

ドキュメント生成方法

mainブランチに対するpullリクエストがあればドキュメント生成を行っておりますが、以下の方法で手動実行することも可能です。

1. Github Actionsの「Deploy static content to Pages」 を開きます

2. 「Run workflow」で 「main」ブランチを指定します

3. 「Run workflow」ボタンを押下するとドライランを行うことができ、実行したActionのArtifactとしてtarファイルをダウンロード可能です。

guide.1on1guide.orgへのデプロイ方法

手動で実行できます。

1. Github Actionsの「Deploy static content to Pages」 を開きます

2. 「Run workflow」で 「main」ブランチを指定します。

3. 「Deploy to GitHub Pages.]にチェックを入れます。

4. 「Run workflow」ボタンを押下し実行してください。

ローカルでのbuild

ここに簡単なbuild方法を記載します。
詳しくは Antoraのドキュメントを参照してください。

1on1ガイドの本編とAntora buildに必要なUIをclone

1. 1on1ガイドの執筆用リポジトリをcloneします

2. Antoraで構築するサイトのUIをcloneします

node_modulesのインストール

本リポジトリのrootディレクトリで以下のコマンドを実行しAntoraをローカルインストールします。

npm ci

build

本リポジトリのrootディレクトリで以下のコマンドを実行すると build/site にビルド結果が出力されます。
この時、「local-antora-playbook.yml」の[content > sources > url]と [ui > bundle > url] はご自身の環境に合わせて変更してください。

npx antora --fetch --stacktrace local-antora-playbook.yml

ファイル構成

.
├─ .github                      (Github向けのファイル)
├─ build/site                   (公開用のディレクトリ)
├─ antora-playbook.yml          (出力用Antora playbook プロジェクト)
├─ local-antora-playbook.yml    (ローカル出力用Antora playbook プロジェクト)
├─ LICENSE                      (ライセンスを記載したファイル)
└─ README.adoc                  (本README)