1on1 meeting guide writing repository

出力先

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

Web上の生成物

ドキュメント生成方法

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

Github Actionsの「Dryrun Github Pages」を開きます
「Run workflow」で「main」ブランチを指定します
「Run workflow」ボタンを押下するとドライランを行うことができ、実行したActionのArtifactとしてtarファイルをダウンロード可能です。

File用サイトのデプロイ方法

リリースを実行すると自動でデプロイされますが、手動でも実行できます。
このデプロイは主にPDFファイルを配置するのに利用しています。

Github Actionsの「Deploy Github Pages」を開きます
「Run workflow」で「main」ブランチを指定します。
「Run workflow」ボタンを押下し実行してください。

guide.1on1guide.orgへのデプロイについて

Github 1on1guide-org/guide.1on1guide.org リポジトリ」を参照してください。

更新に推奨する環境

Visual Studio CodeとAsciiDoc extensionを利用します。

ファイル構成

.
├─ .github                  (Github向けのファイル)
├─ guide                    (ガイドの構成ファイル)
│ ├─ modules                (Antora buildで必要な構成)
│ │ ├─ contents             (本編の情報)
│ │ │ ├─ pages              (本編のページとなるファイル)
│ │ │ │ └─ patterns         (本編中のパターンファイル Notionから自動で書き出す場合あり)
│ │ │ ├─ partials           (Antoraでページ扱いにならない部品)
│ │ │ │ └─ defines          (本編の設定ファイル)
│ │ │ │   └─ common         (本編以外でも利用する設定ファイル)
│ │ │ ├─ images             (本編で利用する共通的な画像ファイル)
│ │ │ └─ navi.adoc          (Antoraで出力する際のナビゲーションファイル)
│ │ ├─ ROOT                 (ROOTになるコンテンツディレクトリ)
│ │ │ ├─ pages              (indexとなるファイルのみ配置)
│ │ │ ├─ partials           (Antoraでページ扱いにならない部品)
│ │ │ └─ defines            (ROOTの設定ファイル)
│ │ │   └─ common           (本編の設定から共通で持つエイリアス)
│ │ │ └─ images             (ROOTで利用する共通的な画像ファイル)
│ └─antora.yml              (Antoraで出力するためにコンテンツソースルートに配置するメタ情報)
├─ customs                  (出力などの制御に必要な構成ファイル)
│ ├─ common                 (出力などの制御に共通で必要な構成ファイル)
│ ├─ html                   (HTML出力の制御に必要な構成ファイル)
│ ├─ notion2adoc            (Notionで記載したパターンをAsciidocに変換するためのファイル)
│ └─ pdf                    (PDF出力の制御に必要な構成ファイル)
├─ public                   (公開用のディレクトリ)
│ ├─ pdf                    (出力されたPDF)
│ └─ html                   (出力された非公開HTML)
├─ index.adoc               (出力用インデックスファイル)
├─ LICENSE.adoc             (ライセンスを記載したファイル)
└─ README.adoc              (本README)

管理者

本リポジトリは以下のメンテナーにて管理されています。コントリビューターについては初回の正式版以降に検討される予定です。

メンテナー

コントリビューター

現在はメンテナーが直接レビュー依頼をした方に貢献いただいています。

1on1guide-org/1on1meeting-guide