コミュニティを運営しているのだが、コミュニティの集合知をキャッチアップする必要があるために、以下の要件が必要。
- 持続可能なページを作る
- 数十年の維持が期待できる
- 維持費用をかけない
- 管理者が死んでも消えない
- サービスがそうそう消えない
- サービス停止時にAlternativeの用意が簡単
- 複数人で管理できる
- CUI
- Markdown
- UTF-8
- インターネットに公開
- SEO
更に、上記を満たすものの中に、wiki ページを作りたい。
具体的には、読書会をやっているのだがひとつひとつの用語を勉強する議論をしたい。
今回は、GitLab とし、その中に Group としてコミュニティ名を追加し、
コミュニティの外部へ出したいプロジェクトを分け、アクティビティとしてプロジェクトを設定することにした
目標
- コミュニティ名「akbrobot」として、 https://akbrobot.gitlab.io を公開し、プロジェクトへのリンクを貼る
- プロジェクト「test」として、https://akbrobot.gitlab.io/test を公開し、wiki へのリンクを貼る
- プロジェクト「test」の wiki を作成して、インターネットに公開する
- プロジェクト「test」の wiki 内で、図や数式を編集可能な状態で収容する
GitHub と GitLab の Pages の比較
GitHub も GitLab も公開用サイトのソースを markdown などで作成し、変換して一般の静的Webサイトとして公開することができる。
GitHub の場合
- https(s)://username.github.io
- または
- https(s)://organizationname.github.io
プロジェクト名自体を usename.github.io または organizationname.github.io とすると、上記で表示することができるようになる。
更に、 個別プロジェクトを以下のようにして公開できる。
- https(s)://username.github.io/projectname
- https(s)://organizationname.github.io/projectname
プロジェクト中のレポジトリのルートが GitHub Pages のルートとなる。
GitLab の場合
- https(s)://username.gitlab.io
- または
- https(s)://groupname.gitlab.io
プロジェクト名自体を usename.gitlab.io または groupname.gitlab.io とすると、上記で表示することができるようになる。
更に、 個別プロジェクトを以下のようにして公開できる。
- https(s)://username.gitlab.io/projectname
- https(s)://groupname.gitlab.io/projectname
- http(s)://groupname.gitlab.io/subgroup/projectname
プロジェクト中のレポジトリの /public が GitHub Pages のルートとなるのが GitHub との違い。
/public に html をそのまま設置しても良いし、設定した静的サイトジェネレータで /public にビルドするようにしても良い。
GitLab で設定を行う
やること(やったこと)
- akbrobot ユーザを作る
- グループを作る
- グループ名を調整する
- プロジェクトを作成する
- GitLab Pagesを作成する
- GitLab Pagesを公開する
- wiki を作る
- wiki を公開する
- wiki で編集可能な数式や図を記述する
akbrobot ユーザを作る
よくわからずにつくりはじめたので、まずターゲットとするサイト名「akbrobot」を持つユーザを作った。しかしながら「akbrobot」をユーザ名にする必要はなく、「akbrobot」をグループ名とするので良かった。後で変更を行う。
ユーザー設定のLocalizationで日本語を設定しておく。
なお、この記事内のキャプチャーは日本語設定していないときに取得したものがあるので表示が異なるかもしれない。
ユーザ名を修正
グループ名を修正
グループ名をユーザ名にかぶっていたので、akbrobot1 と設定してしまったのを akbrobot に修正。
グループ内に Pages 用プロジェクトを作成
「New project」
「Create from template」から
「Pages/Plain HTML」を選択
プロジェクト名を「test」とします。
しばらくしたら test プロジェクトが作成されます
test プロジェクトを pages に公開
「pipelines」 を選び、「Run pipeline」
最初だけクレジットカードの入力を求められます。
pipeline が終了したところ
https://akbrobot.gitlab.io/test/ にアクセスすると Pages が表示されます。
test プロジェクト Wiki を作成する
wiki は GitLab Pages に設置するのではなく、普通にレポジトリ内に設置する。 GitLab Pages で表示するやり方もあるようだが、今回はそれは行わず、 GitLab Pages から wiki へのリンクを貼るだけとした。
test プロジェクト内の wiki を選択する
title を home とし、適当に中身を書いて Create page します。
同様に、いくつかページを作っておきます。
[...](~~~) と書き込むと、~~~ ページへのリンクが ... として作られます。
wiki のページリストは右側に出てきます。
GitLab pages から wiki ページへのリンクを貼る
test Repository の public/index.html を更新します。今回は Web IDE を使ってみました。
リンクを書き換えて
commit します。
Group の Pages から Project の Pages へのリンクを貼る
group ページから New Project を選びます。
先ほどと同じように template を選び、Pages/Plain HTML で
<グループ名>.github.io という名前で作成します。
Run pipeline を押して、20秒ほど待ちます。
https://<グループ名>.github.io という名前でアクセスができることを確認します。
レポジトリの /public/index.html を書き換えて project へのリンクを作ります。
GitHub Pages, wiki を公開する
今まで作ったものは部外者が閲覧しようとするとサインインを求められます。
まずは 「Settings」-「General」-「Visivility,project features,permissions」の中の Pages を 「Evenryone」へ。
プロジェクトのパーミッションが Private になっているのですが現時点では変更できません。
先に、Group の Visibility level を Public にしておく必要があります。
Group が Public になっていると、 プロジェクトも Public に変更できます。
wiki で図や数式を書く
画像はコピー貼り付けでアップロードできるので便利ですが、再編集ができません。
以下のように書くと、
数式や図が入ります。
数式は $~$ でインライン、$$~$$ でブロック配置で書くことができます。\(~\) でも数式がかけるようですが、うまくいくときとうまくいかないときがありました。
また、図については編集時、このマークを押すと
diagrams.net が起動し、編集することができます。
diagrams.net でテキスト・数式入りの複雑な図も書くことができますが、
GitLab wiki に戻ると日本語が文字化けしてしまうので、テキストや数式は GitLab 上の markdown で書くのが良さそうです。
