LoginSignup
3
0

More than 3 years have passed since last update.

GitHubの公式のドキュメントのGitHub Docsがオープンソースになった

Posted at

GitHub公式ブログ(英語)で、GitHubの公式ドキュメントサイトがオープンソースになったとアナウンスされていました。

2020年7月にリニューアルして立ち上げた docs.github.com が対象となっており、そのソースは下のレポジトリに公開されてす。(CC-BY license)

ReadMe Card

また、ドキュメントの右側に、"Make a contribution" ボタンが追加されており、このボタンを押すとそのまま Markdown形式の元のファイルを編集してPRを送ることができるみたい。

もちろん、いきなりPRではなく issue を立てるということもOK。
詳しい貢献方法については、こちらの公式文書(英語)を。

このレポジトリはドキュメントの中身のMarkdown以外のコードもちゃんと含まれていて、
先日紹介記事を書いたCode ScanningのCodeQLを利用するActionsのYAMLファイルもばっちりありました。

GitHubだし、Pagesみたいに Markdownで書いてJekyllで静的サイトを作ってるのかなと、勝手に思ってましたが、server.js みたいな、サーバーサイドっぽいコードもあって、ちょっとびっくりしました。

記載によるとGitHub Docsのチームはpre-production (一般公開前) な内容は、公開レポジトリと定期的に同期させているプライベートレポジトリ上で作業をしているとのこと。
(そうしないと発表会と同時にドキュメントが準備万端でサービスインすることができませんよね。)

これで、「Web UIのみのマニュアルしか公開されていない」「ファイルベースで設定するための仕様が記述されていない」なんていう状況が変わっていけばいいですね。
もちろん、日本語訳がよくわからんなんて状況も多々ありますが有志によってどんどん良くなっていくといいですよね・・・と思いましたが、今は翻訳記事への貢献は受け付けていないようです。残念。

GitHubのドキュメントを読んでいて、ここもっとこうすればいいのにって思ったら、ぜひPRを書いてみてください!

余談

先日同じくアナウンスされたばかりだったと思いますが、このレポジトリはすでに master でなはく main ブランチに名称変更済みでした。

3
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
0