MariaDB ナレッジベースへの貢献

MariaDB と同じように、このナレッジベースは貢献者によるコミュニティで開発されています。 あなたも参加しませんか? アカウントを作成、または OpenIDのアカウントでログイン (Launchpad のユーザーページの URL が必要) し、ナレッジベース上の記事で知識を共有します。

探しているものが見つかりませんか? カテゴリページのサイドバーにある Ask a question here をクリックしてください。 貢献者や MariaDB 専門家はナレッジベースの質問に答えると、一般的な質問のために記事を作成します。 未解決の問題を見て、私たちが他のユーザーを助けるのを助けてください。

備考: ナレッジベースは、MariaDB の有償サポートについて質問するのに適切な場所ではありません。代わりに、MariaDBのContactページ を利用してください。

他のナレッジベース貢献者と連絡を取るには、freenode に作成された IRCの#mariaチャンネル に参加するか、Launchpad の Maria Docs グループとそのメーリングリストに参加してください。 自己紹介を忘れないようにしましょう。

MariaDB 自体への貢献に関する情報については、MariaDBプロジェクトへの貢献 を参照してください。

既存の記事の改善

既存の記事について、間違いを見つけた場合や、改善や内容を充実させることが可能な場合は、「Edit」ボタンをクリックしてください。

記事の編集が完了したら、「Revision comment」を記入してください。 これは編集者が編集内容を見直すときに役立ちます。

新しい記事の作成

ナレッジベースに記事を作成することは、任意のカテゴリ上で質問をすることと似ています。 まず、その記事があるべきだと思うカテゴリに移動します。 そこで今一度、同じような内容の記事がすでに存在しないか慎重に確認します。 新しい記事を作成することよりも、(可能であれば) 既存の記事を更新改善することの方が、通常は良いやり方です。

新しい記事が必要であると判断した場合は、「Create Article」ボタンをクリックします。 ログインしているのにそのボタンが見つからない場合は、おそらくカテゴリではなく記事を開いています。 その場合は、ページの上の方にあるパンくずリストを使い、親カテゴリに移動します。

コンテンツだけでなく Excerpt (抜粋) を追加することもできます。 記事を作成する前に、コンテンツの Preview (プレビュー) を表示して、リンクや書式設定がすべて正しいか確認することができます。

記事を編集・作成する際、監視するか否か選択できます。 記事を監視すると、ページが更新されるたびに電子メールを受信することができます。 監視を停止するには、「Subscriptions」ボタンをクリックして「Unsubscribe」するか、「Edit」ボタンをクリックし「Subscribe to Updates」のチェックを外して「保存」をクリックします。

コンテンツの書式設定

記事、質問、コメント、カテゴリの Comment、記事・カテゴリの Excerpt は、Creoleマークアップ言語 で書式設定されます。 編集のヘルプ カテゴリには、対応している記法やマクロなどの情報がまとめられています。 MediaWiki や 他の Wiki 記法に慣れていれば、Creole を難なく習得できるかと思います。

ナレッジベースの記事の翻訳

ナレッジベースの記事の翻訳に関する情報については 翻訳の手順 を参照してください。

自分 (または他人) の編集履歴の閲覧方法

履歴ページのユーザー名をクリックすることで、自分、または他人の最近の編集履歴を閲覧できます (JavaScript を有効にしておく必要があります)。https://mariadb.com/kb/user/id/ユーザー名 のような形式の URL から直接アクセスすることもできます。

ナレッジベースへの貢献に関する全ユーザーの統計を、こちらから閲覧できます: https://mariadb.com/kb/stats/users/

スタイルノート

  • 新しい記事は、英語で作成してください。 これは、コンテンツが英語のみで利用可能だと考えているという意味ではありません。 私たちは、コンテンツが可能な限り多くの言語で利用できるようにしたいと思います。 しかしながら、新たな記事の正確性を検証できるようにするには、まず英語で書かれる必要があります。
  • US 英語 (アメリカ英語) を使用してください。
  • 複雑すぎず、英語を第二言語とする人が理解できるようなテキストを書いてください。
  • 他の記事へは惜しまずリンクを張ってください。
  • 大胆に行きましょう。コンテンツが正確でありさえすれば、下手な英語やすべてのマークアップ上の慣例を理解していないことを恐れないでください — たいていは誰かがそれらを修正しに来てくれます。
  • ページのタイトルは Title Case にしてください。 (Server system variables ではなく Server System Variables のように、重要な単語を大文字で始める)。to the and のような短い機能語 (前置詞や冠詞、接続詞など) は小文字で始めます。
  • セクションの見出しについては、最初の単語のみ大文字で始めてください。 (たとえば Style Notes ではなく Style notes)。
  • Excerpt (抜粋) はすべての記事に設定すべきで、記事のタイトルを若干詳しくしたものが理想的です。 Excerpt は、カテゴリページの記事タイトルの下に表示されます。
  • コードのサンプルは、<<code>>マクロ<<sql>>マクロ など、適切な マクロ を用いて埋め込むべきです。
  • 書式設定について詳しくは 編集のヘルプ を参照してください。

タスク

ナレッジベースのタスクや誤りを報告、管理するために、MariaDB課題管理システム (JIRA) を利用することができます (ナレッジベースの課題を作成するときは「コンポーネント」に Documentation を選択)。 改善が必要なものを見つけた場合、単にそのページを編集するか、よくわからない場合は maria-docsのメーリングリスト でそのアイデアについて話し合ってください。

Comments

Comments loading...