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

Update to reflect the fact that we don't have an incoming/ FTP directory

Browse source 
any more.
This commit is contained in:
Nik Clayton 2000-03-21 18:52:08 +00:00
parent 817709df11
commit 350533fb83
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=6823
1 changed files with 19 additions and 25 deletions

42
en/docproj/submitting.sgml
View file

@ -1,10 +1,10 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD: www/en/docproj/submitting.sgml,v 1.4 1999/09/06 07:02:43 peter Exp $">
<!ENTITY date "$FreeBSD: www/en/docproj/submitting.sgml,v 1.5 1999/12/12 16:24:16 jhb Exp $">
<!ENTITY title "FreeBSD Documentation Project: Submitting documentation">
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
]>
<!-- $FreeBSD: www/en/docproj/submitting.sgml,v 1.4 1999/09/06 07:02:43 peter Exp $ -->
<!-- $FreeBSD: www/en/docproj/submitting.sgml,v 1.5 1999/12/12 16:24:16 jhb Exp $ -->
<html>
&header;
@ -14,15 +14,16 @@
<p>First, thank you for taking the time to do this.</p>
<p>You should make your documentation available for review. If you can,
put it on an FTP site or a website. If you don't have your own FTP or
webspace, upload your documentation to <a
href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a>, and use <b>send-pr</b> (as outlined below) to
ask one of the committers to make it available.</p>
put it on an FTP site or a website.</p>
<p>Then post a message to the -doc mailing list, with a brief outline of
the documentation and the pointer to its location, and solicit
feedback.</p>
<p>If, for some reason, you can not put the documentation up for FTP or on
a web site somewhere you can send it directly to the -doc mailing list.
If you do this, please only send plain text documents.</p>
<p>You should probably cc: this request for comments to other appropriate
mailing lists. For example, something that relates to how to use CVSup to
keep your source tree up to date would be of interest to the subscribers
@ -49,9 +50,12 @@
<p>which will produce <tt>doc.tar.gz</tt>.</p>
<p>You should then upload <tt/doc.tar.gz/ (obviously, give it a more
sensible name, but keep the <tt/.tar.gz/ bit) to <tt/ftp.FreeBSD.org/,
and put it in the directory <tt>/pub/FreeBSD/incoming/</tt>.</p>
<p>Finally, encode the file so that it will not be mangled by any e-mail
programs.</p>
<pre>
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
</pre>
<p>You should then let the Documentation Project know about it. The
correct way to do this is to use a command called <b>send-pr</b>, which
@ -69,8 +73,8 @@
to fill it out.</p>
<p>Make sure the "Category" is set to "docs" and that the "Class" is set
to one of "change-request". And do not forget to include the name of the
file that you uploaded, so that the committers can find it!</p>
to one of "change-request". You should include the <tt>.uue</tt> file
you created earlier in to the PR.</p>
<p>When you come out of the editor the PR will be sent as an e-mail to the
right place. You will get a notification message shortly afterwards
@ -121,19 +125,9 @@
to the file <tt/foo.diff/.</p></li>
</ol>
<p>You can then send <tt/foo.diff/ back to the project.</p>
<p>You can either FTP the <tt/foo.diff/ file to <a
href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a> or, if it is fairly small (perhaps you are just
fixing a typo) you can include the diff directly in the PR, in the
"Fix:" section.</p>
<p>Either way, you are still going to be using <b>send-pr</b> to let the
committers know about the change. If you do this, make sure that
"Category" is set to "docs" and that "Class" is one of either
"doc-bug" (if your change fixes a problem, such as a typo) or
"change-request" (if you are adding new information to an existing
section).</p>
<p>You can then send <tt/foo.diff/ back to the project. Send a PR as
described earlier, but include the <tt/foo.diff/ file in the body of the
PR.</p>
<p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
&footer