Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
GitHubでポータルサイトドキュメントを運営して幸せになる話 / Operating Por...
Search
iwashi
November 26, 2022
Technology
0
370
GitHubでポータルサイトドキュメントを運営して幸せになる話 / Operating Portal Site with GitHub Pages
GitHub Satellite Tokyo 2018 の LT にて、登壇したときの資料です。
iwashi
November 26, 2022
Tweet
Share
More Decks by iwashi
See All by iwashi
n=1の経験が紡ぐエンジニアリングマネジメントの可能性 / The Possibilities of Engineering Management from n=1 Experiences
iwashi86
11
1.5k
エンジニアリングが好きな私たちのためのエンジニアリングマネジャー入門 / Engineering management for the rest of us
iwashi86
22
5.2k
エレガントパズル 30分 ダイジェスト版/ Elegant Puzzle 30min Digest
iwashi86
5
570
エレガントパズル エンジニアのマネジメントという難問にあなたはどう立ち向かうのか / Elegant Puzzle
iwashi86
18
4k
ベロシティを高く保つ仕事のすすめ方 / Maintaining a High Velocity as Productivity Hacks
iwashi86
54
20k
マネージャー&リーダー向け 社内トレーニング / Training of management and leadership for Stockmark
iwashi86
65
32k
30分でわかる「エンジニアのためのドキュメントライティング」- インフラエンジニアBooks / Docs for Developers within 30 minutes
iwashi86
9
2.5k
エンジニアのためのドキュメントライティング / Docs for Developers
iwashi86
34
22k
なぜ変化を起こすのが難しいのか? - 数年以上にわたって難しさに向き合い・考え取り組んできたこと / The reason why changing organization is so hard - What I thought and faced for more than several years
iwashi86
60
88k
Other Decks in Technology
See All in Technology
短縮URLをお手軽に導入しよう
nakasho
0
120
開発組織のための セキュアコーディング研修の始め方
flatt_security
3
2.8k
Tech Blogを書きやすい環境づくり
lycorptech_jp
PRO
1
270
Visualize, Visualize, Visualize and rclone
tomoaki0705
9
72k
ディスプレイ広告(Yahoo!広告・LINE広告)におけるバックエンド開発
lycorptech_jp
PRO
0
140
Share my, our lessons from the road to re:Invent
naospon
0
120
レビューを増やしつつ 高評価維持するテクニック
tsuzuki817
2
880
全文検索+セマンティックランカー+LLMの自然文検索サ−ビスで得られた知見
segavvy
2
140
OpenID Connect for Identity Assurance の概要と翻訳版のご紹介 / 20250219-BizDay17-OIDC4IDA-Intro
oidfj
0
440
Helm , Kustomize に代わる !? 次世代 k8s パッケージマネージャー Glasskube 入門 / glasskube-entry
parupappa2929
0
280
1行のコードから社会課題の解決へ: EMの探究、事業・技術・組織を紡ぐ実践知 / EM Conf 2025
9ma3r
3
990
プロダクトエンジニア 360°フィードバックを実施した話
hacomono
PRO
0
130
Featured
See All Featured
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
12
980
Building Adaptive Systems
keathley
40
2.4k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
160
15k
Measuring & Analyzing Core Web Vitals
bluesmoon
6
250
The Cult of Friendly URLs
andyhume
78
6.2k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
129
19k
We Have a Design System, Now What?
morganepeng
51
7.4k
Product Roadmaps are Hard
iamctodd
PRO
50
11k
Adopting Sorbet at Scale
ufuk
74
9.2k
Site-Speed That Sticks
csswizardry
4
390
Music & Morning Musume
bryan
46
6.4k
Fireside Chat
paigeccino
34
3.2k
Transcript
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を活用してはいかがでしょうか? おしまい