chiark / gitweb /
Fix typo
[developers-reference.git] / new-maintainer.dbk
index e277466cade7413795949a7c2a63db3d46171957..5ff7cccd860b5654b05e9d2173c575888f5690b6 100644 (file)
@@ -1,27 +1,28 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+  <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
+]>
 <chapter id="new-maintainer">
 <title>Applying to Become a Maintainer</title>
 <section id="getting-started">
 <title>Getting started</title>
 <para>
 So, you've read all the documentation, you've gone through the <ulink
-url="http://www.debian.org/doc/maint-guide/">Debian New Maintainers'
+url="&url-newmaint-guide;">Debian New Maintainers'
 Guide</ulink>, understand what everything in the <systemitem
 role="package">hello</systemitem> example package is for, and you're about to
 Debianize your favorite piece of software.  How do you actually become a Debian
 developer so that your work can be incorporated into the Project?
 </para>
 <para>
-Firstly, subscribe to <email>debian-devel@lists.debian.org</email> if you
-haven't already.  Send the word <literal>subscribe</literal> in the
-<emphasis>Subject</emphasis> of an email to
-<email>debian-devel-REQUEST@lists.debian.org</email>.  In case of problems,
-contact the list administrator at <email>listmaster@lists.debian.org</email>.
-More information on available mailing lists can be found in <xref
-linkend="mailing-lists"/> .
-<email>debian-devel-announce@lists.debian.org</email> is another list which is
+Firstly, subscribe to &email-debian-devel; if you haven't
+already.  Send the word <literal>subscribe</literal> in the
+<literal>Subject</literal> of an email to
+&email-debian-devel-req;.  In case of problems, contact the
+list administrator at &email-listmaster;.  More information on
+available mailing lists can be found in <xref linkend="mailing-lists"/> .
+&email-debian-devel-announce; is another list which is
 mandatory for anyone who wishes to follow Debian's development.
 </para>
 <para>
@@ -30,41 +31,40 @@ doing any coding, and you should post about your intentions to work on
 something to avoid duplicated effort.
 </para>
 <para>
-Another good list to subscribe to is
-<email>debian-mentors@lists.debian.org</email>.  See <xref linkend="mentors"/>
-for details.  The IRC channel <literal>#debian</literal> can also be helpful;
-see <xref linkend="irc-channels"/> .
+Another good list to subscribe to is &email-debian-mentors;.
+See <xref linkend="mentors"/> for details.  The IRC channel
+<literal>#debian</literal> can also be helpful; see <xref
+linkend="irc-channels"/> .
 </para>
 <para>
-When you know how you want to contribute to Debian GNU/Linux, you should get in
-contact with existing Debian maintainers who are working on similar tasks.
-That way, you can learn from experienced developers.  For example, if you are
-interested in packaging existing software for Debian, you should try to get a
-sponsor.  A sponsor will work together with you on your package and upload it
-to the Debian archive once they are happy with the packaging work you have
-done.  You can find a sponsor by mailing the
-<email>debian-mentors@lists.debian.org</email> mailing list, describing your
-package and yourself and asking for a sponsor (see <xref linkend="sponsoring"/>
-and <ulink
-url="http://people.debian.org/~mpalmer/debian-mentors_FAQ.html"></ulink> for
-more information on sponsoring).  On the other hand, if you are interested in
-porting Debian to alternative architectures or kernels you can subscribe to
-port specific mailing lists and ask there how to get started.  Finally, if you
-are interested in documentation or Quality Assurance (QA) work you can join
-maintainers already working on these tasks and submit patches and improvements.
+When you know how you want to contribute to &debian-formal;,
+you should get in contact with existing Debian maintainers who are working on
+similar tasks.  That way, you can learn from experienced developers.  For
+example, if you are interested in packaging existing software for Debian, you
+should try to get a sponsor.  A sponsor will work together with you on your
+package and upload it to the Debian archive once they are happy with the
+packaging work you have done.  You can find a sponsor by mailing the
+&email-debian-mentors; mailing list, describing your package
+and yourself and asking for a sponsor (see <xref linkend="sponsoring"/> and
+<ulink url="&url-mentors;"></ulink> for more information on
+sponsoring).  On the other hand, if you are interested in porting Debian to
+alternative architectures or kernels you can subscribe to port specific mailing
+lists and ask there how to get started.  Finally, if you are interested in
+documentation or Quality Assurance (QA) work you can join maintainers already
+working on these tasks and submit patches and improvements.
 </para>
 <para>
 One pitfall could be a too-generic local part in your mailadress: Terms like
 mail, admin, root, master should be avoided, please see <ulink
-url="http://www.debian.org/MailingLists/"></ulink> for details.
+url="&url-debian-lists;"></ulink> for details.
 </para>
 </section>
 
 <section id="mentors">
 <title>Debian mentors and sponsors</title>
 <para>
-The mailing list <email>debian-mentors@lists.debian.org</email> has been set up
-for novice maintainers who seek help with initial packaging and other
+The mailing list &email-debian-mentors; has been set up for
+novice maintainers who seek help with initial packaging and other
 developer-related issues.  Every new developer is invited to subscribe to that
 list (see <xref linkend="mailing-lists"/> for details).
 </para>
@@ -77,8 +77,13 @@ In addition, if you have some packages ready for inclusion in Debian, but are
 waiting for your new maintainer application to go through, you might be able
 find a sponsor to upload your package for you.  Sponsors are people who are
 official Debian Developers, and who are willing to criticize and upload your
-packages for you.  Please read the unofficial debian-mentors FAQ at <ulink
-url="http://people.debian.org/~mpalmer/debian-mentors_FAQ.html"></ulink> first.
+packages for you.
+<!-- FIXME - out of order
+Those who are seeking a
+sponsor can request one at <ulink url="http://www.internatif.org/bortzmeyer/debian/sponsor/"></ulink>.
+-->
+Please read the unofficial debian-mentors FAQ at <ulink
+url="&url-mentors;"></ulink> first.
 </para>
 <para>
 If you wish to be a mentor and/or sponsor, more information is available in
@@ -89,25 +94,27 @@ If you wish to be a mentor and/or sponsor, more information is available in
 <section id="registering">
 <title>Registering as a Debian developer</title>
 <para>
-Before you decide to register with Debian GNU/Linux, you will need to read all
-the information available at the <ulink
-url="http://www.debian.org/devel/join/newmaint">New Maintainer's
-Corner</ulink>.  It describes in detail the preparations you have to do before
-you can register to become a Debian developer.  For example, before you apply,
-you have to read the <ulink url="http://www.debian.org/social_contract">Debian
-Social Contract</ulink>.  Registering as a developer means that you agree with
-and pledge to uphold the Debian Social Contract; it is very important that
-maintainers are in accord with the essential ideas behind Debian GNU/Linux.
-Reading the <ulink url="http://www.gnu.org/gnu/manifesto.html">GNU
-Manifesto</ulink> would also be a good idea.
+Before you decide to register with &debian-formal;, you will
+need to read all the information available at the <ulink
+url="&url-newmaint;">New Maintainer's Corner</ulink>.  It
+describes in detail the preparations you have to do before you can register to
+become a Debian developer.  For example, before you apply, you have to read the
+<ulink url="&url-social-contract;">Debian Social
+Contract</ulink>.  Registering as a developer means that you agree with and
+pledge to uphold the Debian Social Contract; it is very important that
+maintainers are in accord with the essential ideas behind
+&debian-formal;.  Reading the <ulink
+url="&url-gnu-manifesto;">GNU Manifesto</ulink> would also be
+a good idea.
 </para>
 <para>
 The process of registering as a developer is a process of verifying your
 identity and intentions, and checking your technical skills.  As the number of
-people working on Debian GNU/Linux has grown to over 900 and our systems are
-used in several very important places, we have to be careful about being
-compromised.  Therefore, we need to verify new maintainers before we can give
-them accounts on our servers and let them upload packages.
+people working on &debian-formal; has grown to over
+&number-of-maintainers; and our systems are used in several
+very important places, we have to be careful about being compromised.
+Therefore, we need to verify new maintainers before we can give them accounts
+on our servers and let them upload packages.
 </para>
 <para>
 Before you actually register you should have shown that you can do competent
@@ -123,13 +130,13 @@ Registration requires that you are familiar with Debian's philosophy and
 technical documentation.  Furthermore, you need a GnuPG key which has been
 signed by an existing Debian maintainer.  If your GnuPG key is not signed yet,
 you should try to meet a Debian Developer in person to get your key signed.
-There's a <ulink url="http://nm.debian.org/gpg.php">GnuPG Key Signing
+There's a <ulink url="&url-gpg-coord;">GnuPG Key Signing
 Coordination page</ulink> which should help you find a Debian Developer close
 to you.  (If there is no Debian Developer close to you, alternative ways to
 pass the ID check may be permitted as an absolute exception on a
 case-by-case-basis.  See the <ulink
-url="http://www.debian.org/devel/join/nm-step2">identification page</ulink> for
-more information.)
+url="&url-newmaint-id;">identification page</ulink> for more
+information.)
 </para>
 <para>
 If you do not have an OpenPGP key yet, generate one.  Every developer needs an
@@ -144,7 +151,7 @@ Debian uses the <command>GNU Privacy Guard</command> (package <systemitem
 role="package">gnupg</systemitem> version 1 or better) as its baseline
 standard.  You can use some other implementation of OpenPGP as well.  Note that
 OpenPGP is an open standard based on <ulink
-url="http://www.rfc-editor.org/rfc/rfc2440.txt">RFC 2440</ulink>.
+url="&url-rfc2440;">RFC 2440</ulink>.
 </para>
 <para>
 You need a version 4 key for use in Debian Development.  Your key length must
@@ -160,7 +167,7 @@ DSA (sign only), (5) RSA (sign only).  If you don't have any special
 requirements just pick the default.  </para> <para> The easiest way to tell
 whether an existing key is a v4 key or a v3 (or v2) key is to look at the
 fingerprint: Fingerprints of version 4 keys are the SHA-1 hash of some key
-matieral, so they are 40 hex digits, usually grouped in blocks of 4.
+material, so they are 40 hex digits, usually grouped in blocks of 4.
 Fingerprints of older key format versions used MD5 and are generally shown in
 blocks of 2 hex digits.  For example if your fingerprint looks like
 <literal>5B00 C96D 5D54 AEE1 206B  AF84 DE7A AF6E 94C0 9C7F</literal>
@@ -173,8 +180,8 @@ have to manually add those signatures.  </para> </footnote>
 </para>
 <para>
 If your public key isn't on a public key server such as
-<literal>subkeys.pgp.net</literal>, please read the documentation available at
-<ulink url="http://www.debian.org/devel/join/nm-step2">NM Step 2:
+&pgp-keyserv;, please read the documentation available at
+<ulink url="&url-newmaint-id;">NM Step 2:
 Identification</ulink>.  That document contains instructions on how to put your
 key on the public key servers.  The New Maintainer Group will put your public
 key on the servers if it isn't already there.
@@ -189,7 +196,7 @@ can make special arrangements.
 </para>
 <para>
 To apply as a new maintainer, you need an existing Debian Developer to support
-your application (an <emphasis>advocate</emphasis>).  After you have
+your application (an <literal>advocate</literal>).  After you have
 contributed to Debian for a while, and you want to apply to become a registered
 developer, an existing developer with whom you have worked over the past months
 has to express their belief that you can contribute to Debian successfully.
@@ -197,19 +204,19 @@ has to express their belief that you can contribute to Debian successfully.
 <para>
 When you have found an advocate, have your GnuPG key signed and have already
 contributed to Debian for a while, you're ready to apply.  You can simply
-register on our <ulink url="http://nm.debian.org/newnm.php">application
+register on our <ulink url="&url-newmaint-apply;">application
 page</ulink>.  After you have signed up, your advocate has to confirm your
 application.  When your advocate has completed this step you will be assigned
 an Application Manager who will go with you through the necessary steps of the
 New Maintainer process.  You can always check your status on the <ulink
-url="http://nm.debian.org/">applications status board</ulink>.
+url="&url-newmaint-db;">applications status board</ulink>.
 </para>
 <para>
 For more details, please consult <ulink
-url="http://www.debian.org/devel/join/newmaint">New Maintainer's Corner</ulink>
-at the Debian web site.  Make sure that you are familiar with the necessary
-steps of the New Maintainer process before actually applying.  If you are well
-prepared, you can save a lot of time later on.
+url="&url-newmaint;">New Maintainer's Corner</ulink> at the
+Debian web site.  Make sure that you are familiar with the necessary steps of
+the New Maintainer process before actually applying.  If you are well prepared,
+you can save a lot of time later on.
 </para>
 </section>