Docs header transparent bg

manページ用のドキュメントの書き方

このドキュメント内のコマンドやファイルパスは、rubygems/rubygemsリポジトリのbundler/ディレクトリ内にいることを前提としています。

Bundlerユーザーにとっての主なヘルプソースはmanページです。これはbundle help(またはbundler help)を実行したときに出力されるものです。これらのページはフォーマットやプレビューが少し難しいかもしれませんが、慣れてしまえば非常に簡単です。

注:CLIではbundlerbundleは同じ意味で使用できます。このガイドではbundleを使用します。なぜなら、それがよりかわいいためです。

manページには何を書くべきか?

manページは、CLI(コマンドラインインターフェース)で使用されるBundlerコマンドのために使用します。それらは、(bundle installのように)長いものから、(bundle cleanのように)非常に短いものまで、長さが異なります。

Bundler CLIで使用可能なコマンドのリストを表示するには、次のように入力します。

  $ bundle help

私たちの目標は、すべてのコマンドに対してmanページを用意することです。

コマンドのmanページが見当たらない?新しいページを作成してPRを送ってください!既存のページの編集も歓迎します。

新しいmanページの作成

新しいmanページを作成するには、lib/bundler/man/ディレクトリに新しい.ronnファイルを作成するだけです。

例:コマンドbundle cookies(残念ながら実際のコマンドではありません)のmanページを作成するには、lib/bundler/man/bundle-cookies.1.ronnファイルを作成し、そこにドキュメントを追加します。

フォーマット

私たちのmanページは、Markdownと標準的なmanページ規約を組み合わせたronnフォーマットを使用しています。特にMarkdownをよく使用している場合は、最初は少し奇妙に感じるかもしれません。

ronnガイドのフォーマットガイドでは、一般的なフォーマットの種類について良い概要が提供されています。

一般的に、他のページと同じようにページを作成してください。必要に応じて##OPTIONSのようなセクションや、コードブロック、定義リストのようなフォーマットを使用してください。

フォーマットが正しいかどうか確信がない場合は、問題ありません!あなたが作成したものでプルリクエストを作成してください。私たちが見て確認します。

プレビュー

Bundlerユーザー向けに印刷される変更をプレビューするには、一連のコマンドを実行する必要があります。

$ rake spec:deps $ rake man:build $ man ./lib/bundler/man/bundle-cookies.1

bundle-cookies.1.ronnにさらに変更を加えた場合は、プレビューする前に再度rake man:buildを実行する必要があります。

テスト

ドキュメントのテストがあります!プルリクエストを作成する前に実行する最も重要なテストファイルは、helpコマンドのテストとドキュメント品質のテストです。

$ bin/rspec ./spec/commands/help_spec.rb $ bin/rspec ./spec/quality_spec.rb

Bundlerドキュメントサイトのドキュメントの書き方

Bundlerドキュメントサイトの主要なコマンドまたはユーティリティのいずれかのプルリクエストを送信する場合は、rubygems/rubygemsリポジトリからmanページのドキュメントを作成するための上記の手順に従ってください。それらはどちらの場合も同じです。

注:主要なコマンドとユーティリティのドキュメントのためにrubygems/rubygemsリポジトリから.ronnファイルを編集するだけで十分です🎉。rubygems/bundler-siteリポジトリで手動で何かを変更する必要はありません。なぜなら、manページとBundlerドキュメントサイトの主要なコマンドとユーティリティのドキュメントは、同じものであるからです。それらは、rubygems/rubygemsリポジトリの.ronnファイルからrake man:buildコマンドによって自動的に生成されます。

さらに、ガイドまたはチュートリアルを追加したい場合は、rubygems/bundler-siteリポジトリで、/bundler-site/source/current_version_of_bundler/guidesに移動し、新しいMarkdownファイル.mdで終わる拡張子付き)を追加してください。新しいガイドのタイトルを次のように正しくフォーマットしてください。 --- title: RubyGems.org SSL/TLS Troubleshooting Guide ---

エラーを発見したり、何かが欠けていることに気づいたら、GitHubでこのドキュメントを編集してください