os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

- Merge the following from the English version:

Browse source 
r45075 -> r45415	head/ja_JP.eucJP/htdocs/docproj/submitting.xml
This commit is contained in:
Ryusuke SUZUKI 2016-12-13 12:38:33 +00:00
parent 40a100cd31
commit f8c0f2217a
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=49724
1 changed files with 18 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

69
ja_JP.eucJP/htdocs/docproj/submitting.xml
View file

@ -5,7 +5,7 @@
<!ENTITY title "FreeBSD ドキュメンテーションプロジェクト: ドキュメントの寄稿">
]>
<!-- The FreeBSD Japanese Documentation Project -->
<!-- Original revision: r45075 -->
<!-- Original revision: r45415 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
@ -23,13 +23,12 @@
</p>
<p>レビューのために、ドキュメンテーションを公開する必要があります。
もし可能なら、ドキュメンテーションを FTP やウェブサイトに置いてください。
</p>
もし可能なら、ドキュメンテーションをどこかのウェブサイトにアップロードしてください。</p>
<p>それから、<tt>FreeBSD-doc</tt> メーリングリストへドキュメンテーションの概要と公開場所、
コメントの送り先を記したメッセージを投稿してください。</p>
<p>理由があってドキュメントを FTP やウェブサイトにおけないときは、
<p>理由があってドキュメントをウェブサイトにおけないときは、
<tt>FreeBSD-doc</tt> メーリングリストに直接送って頂いても構いません。
その時はプレインテキストでだけお願いします。</p>
@ -38,42 +37,18 @@
例えば、そのドキュメンテーションが、
ソースツリーを最新の状態に保つための SVN
の使用法について言及しているなら、
その内容は <tt>FreeBSD-current</tt> や <tt>FreeBSD-stable</tt>
メーリングリストの講読者にとっても興味あるものでしょう。</p>
その内容は <tt>FreeBSD-stable</tt>
メーリングリストの講読者にとっても興味あるものでしょう。
cc: は、多くて他の一つのメーリングリストを入れるにとどめてください。</p>
<p>ドキュメンテーションに目が通され、
読者からの提案を組み入れる機会を得たなら、
ドキュメンテーションを寄稿する準備ができたと言えます。</p>
<p>ドキュメンテーションを寄稿する場合、
ファイルを tar 形式にまとめてください。
ドキュメンテーションが <tt>one</tt>、<tt>two</tt>、<tt>three</tt>
という三つのファイルから構成されており、
すべてを <tt>doc.tar</tt> にまとめる場合は、</p>
<pre>
% <b>tar cf doc.tar one two three</b>
</pre>
<p>と入力してください。それから tar 形式のファイルを圧縮します。</p>
<pre>
% <b>gzip -9 doc.tar</b>
</pre>
<p><tt>doc.tar.gz</tt> というファイルが生成されます。</p>
<p>最後にこのファイルがメールプログラムに壊されないようにエンコードします。</p>
<pre>
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
</pre>
<p>それから、
そのことをドキュメンテーションプロジェクトに知らせる必要があります。
御使用のマシンにもインストールされているはずの
<b>send-pr</b> というコマンドを使うのが正しい方法です。
<a href="https://bugs.freebsd.org/bugzilla/enter_bug.cgi">WWW 問題報告フォーム</a>を使用してもかまいません。</p>
<p>ドキュメンテーションを寄稿する場合、障害報告として提出してください。
障害報告については、
<a href="https://www.FreeBSD.org/ja/support/bugreports.html">https://www.FreeBSD.org/ja/support/bugreports.html</a>
で説明されています。</p>
<p>このコマンドを使うのは、
あなたが寄稿したことを後から確認することができるからです。
@ -84,20 +59,12 @@
詳しくは、
<a href="&url.articles;/problem-reports/">FreeBSD 問題報告の書き方</a>を参照してください。</p>
<p><b>send-pr</b> 自体は非常に単純です。ちょっと特殊な形式の e-mail
を特定のアドレスに送るだけだからです。
<b>send-pr</b> を走らせると、エディタ (多分 <b>vi</b> か
<b>emacs</b> でしょう) が立ち上がり、
記入用のテンプレートと記入方の説明が表示されるはずです。</p>
<p>"Category" を "docs" に、"Class" を "change-request"
に設定してください。先に作っておいた <tt>.uue</tt>
ファイルを PR の本文に含めましょう。</p>
<p>エディタを終了させると、PR は e-mail として正しい場所へ送られます。
いくらもしないうちに、あなたが送った PR
の番号を伝える確認のメッセージが送られてくるはずです。
この番号は進展状況を確認するのに使用することができます。</p>
<p>"Product" で "Documentation" を選択し、
"Component" を報告する内容に合わせて "Documentation" もしくは
"Website" を選択してください。
PR には、ファイルを添付してください。
もしその変更についてメーリングリストで議論をしていたのであれば、
その投稿へのリンクを加えてください。</p>
<h2>既存のドキュメンテーションに変更を加えました。
どうやって寄稿すれば良いの?</h2>
@ -142,8 +109,8 @@
へ書き出します。</p></li>
</ol>
<p>プロジェクトへ <tt>foo.diff</tt> を送ります。 上述したように PR を
<tt>foo.diff</tt> ファイルを PR の本文に含めて送ります。</p>
<p>プロジェクトへ <tt>foo.diff</tt> を送ります。 上述したように
<tt>foo.diff</tt> ファイルを PR に添付して送ります。</p>
<p></p><a href="docproj.html">FreeBSD
ドキュメンテーションプロジェクトのページ</a>