GitHubでポータルサイトドキュメントを運営して幸せになる話 / Operating Portal Site with GitHub Pages

Copyright © NTT Communications Corporation. All rights reserved. GitHubでポータルサイトドキュメントを運営して幸せになる話
GitHub Satellite Tokyo 2018 NTTコミュニケーションズ岩瀬義昌 / @iwashi86 2018.6.12

GitHub Pages※ 使ってますか？ ※ 詳細は後述するが、簡単に言うとGitHubが提供する静的Webサイトのホスティング機能

GitHub Pages と CI/CD ※ を組み合わせてますか？ ※ CI: Continuous Integration、継続的インテグレーションのこと
CD: Continuous Delivery・Deployment、継続的デリバリ・デプロイのこと

GitHub(Pages)をフル活用して幸せになる方法を知ること本LTのゴール

・岩瀬義昌 / @iwashi86 ・WebRTC※ のPaaSである　SkyWayのTech Lead ・Fukabori.fm(Podcast)主催 ※
音声・映像・データをリアルタイムに　通信するための技術のこと

SkyWayはGitHubと同じく開発者向けのサービス https://webrtc.ecl.ntt.com/

GitHub ・gitのホスティング(マネージ)、　　Pull Request含む開発フロー、SNS など・OSSや個人Publicリポジトリは無償

GitHub ・gitのホスティング(マネージ)、　　Pull Request含む開発フロー、SNS など・OSSや個人Publicリポジトリは無償 SkyWay ・WebRTCの面倒なところを　　マネージドとして提供・個人で作るサービスレベル※
ならまず無償 ※ 10万回の接続、500GB/月のトラフィックは無償

本題

GitHub Pagesとは

GitHub Pagesとは・静的Webサイトのホスティング機能

GitHub Pagesとは・静的Webサイトのホスティング機能・GitHubがマネージしてくれるため運用レス

GitHub Pagesとは・静的Webサイトのホスティング機能・GitHubがマネージしてくれるため運用レス・開発者の個人ブログだけでなく　企業のウェブサイトに利用可能

gh-pagesの例: MicrosoftのWebサイト https://opensource.microsoft.com/

GitHub Pages を使うモチベーションとは？

1. GitHub を使うこと自体のメッセージ 2. CI/CD との組み合わせによる品質向上補足：そもそも、マネージドによるWebホスティングなどもありますが　　　SkyWayで活用するにあたり、特に価値があったと考える点に絞ります

1. GitHub を使うこと自体のメッセージ 2. CI/CD との組み合わせによる品質向上

1. GitHub を使うこと自体がメッセージ

1. GitHub を使うこと自体がメッセージ・SkyWayは2013年12月にリリース　GitHubのアカウントも公開

1. GitHub を使うこと自体がメッセージ・SkyWayは2013年12月にリリース　GitHubのアカウントも公開・このときの外部からの声

https://twitter.com/laiso/status/410226600362266624

1. GitHub を使うこと自体のメッセージ 2. CI/CD との組み合わせによる品質向上

そもそもエンジニア的にはドキュメントを…

・Markdown / reStructuredText で書きたいそもそもエンジニア的にはドキュメントを…

・Markdown / reStructuredText で書きたい・git で管理して、Pull Request Drivenで　書きたい＆レビューしたい　(Wordは現時点でgitに向いていない)
そもそもエンジニア的にはドキュメントを…

・Markdown / reStructuredText で書きたい・git で管理して、Pull Request Drivenで　書きたい＆レビューしたい・表記揺れなどのレビューは、
　人間がやるものじゃないそもそもエンジニア的にはドキュメントを…

思いを反映した結果…

ドキュメント開発/運用の全体像(SkyWayでの例) 開発マシン GitHub ③テスト結果 (Pass/Fail)を返却 ②CircleCI上で、 textlintを使ったテスト実行 ①ブランチを切って文書を追加(mkdocs)
④レビューReady を通知その他メンバ ⑤文書レビュー ⑥GitHub Pagesに　masterをデプロイ

開発マシン GitHub ③テスト結果 (Pass/Fail)を返却 ②CircleCI上で、 textlintを使ったテスト実行 ①ブランチを切って文書を追加 (MkDocs)
④レビューReady を通知その他メンバ ⑤文書レビュー ⑥GitHub Pagesに　masterをデプロイドキュメント開発/運用の全体像(SkyWayでの例)

https://www.mkdocs.org/

MkDocs とは・Markdownで書けるPythonベースの　静的Webサイトジェネレータ　 (類似のツールは Sphinx など)

MkDocs とは・Markdownで書けるPythonベースの　静的Webサイトジェネレータ　 (類似のツールは Sphinx など) ・ビルドすると、HTML/JS/CSS を吐き出すので、
　それを任意の方法でデプロイする　 e.g. GitHub Pages、S3へ置く

開発マシン GitHub ③テスト結果 (Pass/Fail)を返却 ②CircleCI上で、 textlintを使ったテスト実行 ①ブランチを切って文書を追加(mkdocs) ④レビューReady
を通知その他メンバ ⑤文書レビュー ⑥GitHub Pagesに　masterをデプロイドキュメント開発/運用の全体像(SkyWayでの例)

textlint とは・lintは元々、C言語用の構文・文法チェッカだったが　今では複数言語(e.g. html や golang )に対応

textlint とは・lintは元々、C言語用の構文・文法チェッカだったが　今では複数言語(e.g. html や golang )に対応・textlintは、lintの適用範囲を拡張して、　文章に適用して、文章品質をテスト可能にしたツール
　(類似のツールは、 RedPen など)

textlint とは・lintは元々、C言語用の構文・文法チェッカだったが　今では複数言語(e.g. html や golang )に対応・textlintは、lintの適用範囲を拡張して、　文章に適用して、文章品質をテスト可能にしたツール
　(類似のツールは、 RedPen など) ・NGを指摘するだけでなく、自動修正も可能

引用: https://qiita.com/azu/items/e36501d25593d008f6ac textlint の例人間ではなくプログラムに指摘 -> 修正してもらう

開発マシン GitHub ③テスト結果 (Pass/Fail)を返却 ②CircleCI上で、 textlintを使ったテスト実行 ①ブランチを切って文書を追加(mkdocs) ④レビューReady
を通知その他メンバ ⑤文書レビュー ⑥GitHub Pagesに　masterをデプロイドキュメント開発/運用の全体像(SkyWayでの例)

Circle CIとは・定番の CI as a Service の1つ

Circle CIとは・定番の CI as a Service の1つ・リポジトリに書込権限の　ある鍵を追加することで
　デプロイまで実現可能

ドキュメント開発/運用の全体像(SkyWayでの例) 開発マシン GitHub ③テスト結果 (Pass/Fail)を返却 ②CircleCI上で、 textlintを使ったテスト実行 ①ブランチを切って文書を追加(mkdocs)
④レビューReady を通知その他メンバ ⑤文書レビュー ⑥GitHub Pagesに　masterをデプロイ

まとめ

まとめ - 本日お話したこと

まとめ - 本日お話したこと・GitHubの利用自体がメッセージの1つ

まとめ - 本日お話したこと・GitHubの利用自体がメッセージの1つ・GitHub Pages を CI/CD と組み合わせる方法

まとめ - 本日お話したこと・GitHubの利用自体がメッセージの1つ・GitHub Pages を CI/CD と組み合わせる方法自サイト/ドキュメントの管理に
GitHubを活用してはいかがでしょうか？おしまい

GitHubでポータルサイトドキュメントを運営して幸せになる話 / Operating Por...

GitHubでポータルサイトドキュメントを運営して幸せになる話 / Operating Portal Site with GitHub Pages

More Decks by iwashi

Other Decks in Technology

Featured

Transcript