Cloud Operator Days Tokyo 2022 に動画登壇しました！
こんにちは。エンジニアリングチームの照井です。初めてインフラエンジニアwayに投稿します。 Cloud Operator Days Tokyo 2022 というイベントにおいて、「文書作成ソフトからの脱却 ～Markdownによるアラート対応手順書CI/CD～」という題名で「社内ドキュメント作成の自動化」について動画登壇させていただきました。このイベントではハートビーツがゴールドスポンサーとなっております。 なお、登壇動画はイベントページにて2022/06/27より公開されております。 Cloud Operator Days Tokyoのご紹介 Cloud Operator Days Tokyo は、クラウド運用者に焦点を当てた技術イベントです。 運用技術の発展やインフラ、アプリケーション運用に興味がある若手の教育、育成を目的に掲げています。 Cloud Operator Days Tok
LaRecipe - Markdownから格好良いドキュメントを生成
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 開発者に対して見栄えの良いドキュメントを提供する、これはDevRelにおいて大事な要素です。誰だって使いづらい、読みづらいドキュメントは嫌がるものです。デザインはもちろんのこと、文字サイズや見出しの付け方などによっても可読性は変わってきます。 そこで紹介したいのがLaRecipeです。Laravelを使い、Markdownから綺麗なドキュメントを生成してくれるソフトウェアです。 LaRecipeの使い方 デモです。左側に大見出し、中央がコンテンツ、右側にそのページのアウトラインが表示されます。 コードなども綺麗に表示されます。 アウトプットのデモデザインを入れている例。 ドキュメントの下にはコメント欄が用意されています。 左側の目次は非表示にできます。 検索も使えます。 LaRec
Docusaurus - Facebook製のオープンソース・ドキュメントサイト MOONGIFT
開発ドキュメントの整備は大きな問題です。ソースコードに書かれたりWikiや何らかのCMSを使ったりと様々な方法がありますが、これといった解決策はなかなか見つけられません。 そこで使ってみたいのがDocusaurusです。Facebook製のオープンソース・ドキュメントサイトです。 Docusaurusの使い方 メインページです。 文書はMarkdownで作成します。 ドキュメント部分です。左側に目次、右側にコンテンツが表示されます。 リンクはページ下に付きます。 DocusaurusのコンテンツはMarkdownとなっています。それだけにメンテナンスが容易です。また、UIはReactで作られていますので、表示が高速に行われます。オープンソースのプロジェクトに最適なドキュメント管理かも知れません。 Docusaurusはnode/JavaScript製のオープンソース・ソフトウェア（MIT
Docbase - Markdownから生成する開発者向けドキュメント
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 開発者向けのドキュメントはDX（Developer Experience。開発者体験）を語る上で欠かせない存在です。ドキュメントが間違っているのはもっての外ですが、さらに可読性が高かったり、機能面においても体験を向上できる要素があります。 そんな中、メンテナンスのしやすさもまた大事な要素になります。今回はMarkdownファイルをベースにしたドキュメントシステム、Docbaseを紹介します。 Docbaseの使い方 利用例です。トップページのデザインも格好良いです。 ドキュメント詳細です。右側に目次、中央にコンテンツが表示されます。 コードは文字が大きく見やすくなっています。 別なドキュメントの例です。ヘッダーやフォントなどをカスタマイズできます。右側のカラムは表示されていません。
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
