defigeek-docsの準備

ドキュメントページdocs の作成方針

目的

  • ランディングページが欲しい (便宜上、wwwと呼称)
  • 取りまとめたドキュメントを公開したい (便宜上、docsと呼称)

このトピックはdocsにフォーカスする。

方針転換

今までは、HugoのDocsyテーマでwwwとdocsのどちらも実現しようとしていた。paruさんがwww作りをリーディングしてくれると名乗り上げてくれたので、wwwとdocsのタスクを完全に分離する形としたい。wwwのタスク設定及び報酬を再設定する。

これからは次のようにしたい。

  • docsは、GitBookのコミュニティ版が確保できたので、ひとまずGitBookでホスティングしたい
  • wwwは、従前通り GitHub pages + Static site generatorで進める予定

これにより次の利点を獲得できる。

  • docsを非エンジニア系の人にも容易に更新してもらいやすくなる
    • wwwの作業にブロックされない
  • wwwはdocsへの影響を考慮する必要がなくなる

GitBookを選択した理由

  • クリプト界隈で広く使われているので馴染みがある
  • 扱いやすいUIが装備されており、mdを意識しなくてもよい
  • コンテンツはGitHubにあるリポジトリとsyncされ、フォーマット形式は .mdなのでロックインされにくい

GitBook稼働に必要な作業

[GitHub管理者]

  • リポジトリ defigeek-docs を作成する
  • AdminをGitBook管理者に付与する
    • GitBook上でIntegrationを許可するため
    • WebHookが設定される
    • 許可した管理者の権限に基づいてsyncがかかる

[DNS管理者]

[GitBook管理者]

経緯

補足事項。元々は… docsを作ったのに公開先が決まっていない → 公開先を決める必要がある → 公開方法も決めないといけない → ひとまずドキュメントジェネレーターhugo使うか と課題が連鎖して依存関係が発生していました。

「いいね!」 1

投票

■ドキュメントページのホスティング
合意形成できたドキュメントなどをGitBookというサービスを使って公開したいと思います。
URLには、docs.defigeek.xyz を利用したいです。

投票で確認したい点は次の通りです。

  • ドキュメントの公開に docs.defigeek.xyz というURLを使う
  • GitBookを使う

詳細は上述参照ください。
ご意見は本フォーラムか Discordの #ガイドライン部屋まで。

  • 賛成
  • 反対
  • 異見あり

0 投票者数

defigeek-docsの準備 のタスクを完遂。

https://docs.defigeek.xyz/ でアクセス可能な状態になりました。

「いいね!」 1