Converted all short tags to full tags
[aur-xilon.git] / web / html / beta.html
blobb1b48ac4be287ede12ab2538cde1b814da7063da
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta content="text/html; charset=ISO-8859-1"
5 http-equiv="content-type">
6 <title>AUR Beta</title>
7 </head>
8 <body>
9 <h2>Arch User Repository (AUR) Beta Test</h2>
10 The Arch User Repository (AUR) is ready for beta testing. This release
11 does not contain every feature everyone wanted, but at this stage we
12 think we've implemented the most important features, and we need you to
13 help us make sure they are working properly and reliably. A few months
14 after the initial release, we'll start to prioritize
15 features necessary for the next revision. We'll weigh the suggestions
16 given and decide what additional features to add.<br>
17 <h3><a href="http://bugs.archlinux.org/index.php?tasks=all&amp;project=2">Leave your feedback in Flyspray!</a></h3>
18 <h3>Audience</h3>
19 For this test, we are not using the real Arch servers or
20 network bandwidth. As a result, you will find that
21 bandwidth will be somewhat limited. Please don't upload many large
22 packages, except where doing so helps to test a particular feature (or
23 misfeature) of the system.<br>
24 <br>
25 We expect this beta testing to be performed by TUs and a
26 handful of other users who are interested enough to subscribe to the TU
27 mailing list or otherwise seek out this information. <span
28 style="font-weight: bold;">Please do not advertise this beta site
29 information widely; we will not have the network
30 bandwidth to sustain a high load on the test platform and will need to
31 cut the beta short.</span>
32 Once the beta is over, the real AUR will be hosted on the main Arch
33 Linux
34 servers and will be able to handle the greater demands of the whole
35 community.<br>
36 <br>
37 <h3>Introduction to the AUR<br>
38 </h3>
39 The AUR is a place for community members and TUs (Trusted Users) to
40 work together to bring new packages to Arch Linux users. A TU is a
41 special community member who has earned the trust of the core
42 Arch developers and who wants to help build, test, and debug new Arch
43 packages contributed by members of the community. Only a TU can build a
44 binary package and add it to the AUR
45 repository, which is then accessible via pacman -S.<br>
46 <span style="font-weight: bold;"><br>
47 </span>Any community member may upload new PKGBUILD directory tarballs
48 from the AUR
49 web interface. Those packages will appear in the "Unsupported"
50 repository, and
51 can be viewed and built by other community members, even though they
52 are not yet available in binary form via pacman -S.<br>
53 <br>
54 The AUR system
55 incorporates a voting system which allows members to vote for the
56 packages in "Unsupported" that they think are useful or interesting. If
57 a TU thinks a package is interesting or has received enough votes,
58 the TU may choose to adopt the package. The TU builds the package,
59 performs some rudimentary testing, and adds it
60 to the AUR repository, where it can be accessed by any user subscribing
61 to the AUR repository by running pacman -S. From that point on, the TU
62 will maintain the
63 package in the AUR repository, and all updates for the package must go
64 through a TU.<br>
65 <br>
66 If a package gets enough votes or is otherwise deemed interesting by
67 the core Arch development team, the package may be
68 promoted into the extra or current repository. At that point, the
69 package is removed from the AUR and is maintained by the core
70 developers. Alternately, if a TU loses interest in a package, the TU
71 may abandon the package or remove it from the AUR repository altogether.<br>
72 <br>
73 <h3>Feedback</h3>
74 The most important part of this beta test is your feedback. There is a <a
75 href="http://bugs.archlinux.org/index.php?tasks=all&amp;project=2">project
76 set up in Flyspray</a> for the AUR. Please leave your feedback there.
77 Though it will be tempting to email the AUR developers, remember that
78 they will get a lot of email and they won't be able to find yours later
79 when they're going through the feedback. If you put your bugs,
80 comments, and suggestions in Flyspray, they are guaranteed not to get
81 lost.<br>
82 <br>
83 Flyspray is incredibly easy to use. Take a moment to create an account
84 as soon as you can.<br>
85 <br>
86 <h3>Schedule</h3>
87 The AUR beta is starts now, around February 23. It should run until
88 about the first week in March. At that point, it will look at the remaining
89 problems, fix them, and launch the AUR sometime in mid-to-late March on the
90 production servers.<br>
91 <h3>Using the AUR Repository</h3>
92 To access the AUR repository from pacman, add the following to your
93 pacman.conf:<br>
94 <br>
95 <code>[aur]<br>
96 Server = ftp://subzero.elys.com/arch/aur</code><br>
97 <br>
98 <h3>What The AUR Means to a Community Member</h3>
99 If you're an Arch Linux community member, the AUR represents a giant
100 step forward in your ability to effectively contribute your work in
101 building Arch packages to the rest of the Arch Linux community. The
102 following steps must ye take to get started:<br>
103 <ol>
104 <li>Set yourself up to access the AUR repository, if desired, by
105 adding the above lines to your pacman.conf.<br>
106 </li>
107 <li>Visit the <a href="https://subzero.elys.com">AUR Beta Site</a>.</li>
108 <li>Create a new user account.</li>
109 <li>Begin uploading packages you have created. You should upload a
110 .tar.gz file containing the PKGBUILD directory. You should not include
111 a binary package file in your upload, just the PKGBUILD and related
112 necessary files for building the package. (Imagine your package had
113 been accepted into current or extra; we want just the files that would
114 be fetched by abs in /var/abs.)<br>
115 </li>
116 <li>Review the other packages in the repository, and vote for the
117 ones you find most interesting. If you're especially interested, browse
118 the package contents and build other packages yourself.</li>
119 </ol>
120 <h3>What The AUR Means to a Trusted User (TU) or an Arch Developer<br>
121 </h3>
122 If you are an Arch Linux Trusted User (TU) or an Arch developer, and
123 you want to get started on the beta, do the following:<br>
124 <ol>
125 <li>Set your machine up to access the AUR repository.</li>
126 <li>Run <code>pacman -S tupkg</code> to download the TU package
127 download tool.<br>
128 </li>
129 <li>Visit the <a href="https://subzero.elys.com">AUR Beta Site</a>.</li>
130 <li>Create a new user account, using your usual user id.<br>
131 </li>
132 <li>Email Paul (paul at mattal dot com) and ask to have your login
133 modified to have TU/developer status.<br>
134 This
135 step is necessary so we can make sure that the right people are getting
136 the right access. We will migrate this information to the production
137 system, so you won't have to do it again.<br>
138 </li>
139 <li>Check out the CVS tree for the AUR repository. To do this,
140 execute the following commands:<br>
141 <br>
142 <code>export
143 CVSROOT=":pserver:&lt;userid&gt;@cvs.archlinux.org:/home/cvs-aur-test"<br>
144 cvs login<br>
145 cvs co aur-test</code><br>
146 <br>
147 If you're
148 a TU, you should already have an account in this new
149 repository. If you are a developer, email Jason (jason at archlinux dot
150 org) and he'll set up access for you.<br>
151 </li>
152 <li>Build binary packages for things you wish to place in the AUR,
153 and add the PKGBUILD and accompanying necessary files to the CVS
154 repository. You can do this with:<br>
155 <br>
156 <code>cvs add &lt;directory&gt;<br>
157 cd &lt;directory&gt;<br>
158 cvs add PKGBUILD<br>
159 .<br>
160 .<br>
161 cvs commit</code><br>
162 <br>
163 </li>
164 <li>Upload the binary packages using the "tupkg" tool. Run<span
165 style="font-family: monospace;">:<br>
166 </span><code><br>
167 tupkg
168 --host
169 subzero.elys.com --user &lt;userid&gt; --password &lt;password&gt;
170 &lt;packagefile.pkg.tar.gz&gt;</code><br>
171 <br>
172 Note that this is your <span style="font-weight: bold;">AUR login
173 password</span> -- the one you assign when you create your account, not
174 your CVS password, in case they are different.<br>
175 </li>
176 <li>Once your packages are uploaded successfully, tag the newly
177 created package files with the CURRENT tag in cvs. You can do this with:<br>
178 <code><br>
179 cvs tag -cFR CURRENT &lt;newpackagebuilddir&gt;</code> <br>
180 <br>
181 </li>
182 <li>In 5-10 minutes, the automated script will add them to the AUR
183 repository. Verify that they appear both in the web interface and
184 become
185 available via <code>pacman -Sy &lt;package&gt;</code> from the aur
186 repository.</li>
187 <li>Select the newly added or updated package in the AUR web
188 interface and set yourself as the maintainer.<br>
189 </li>
190 </ol>
191 </body>
192 </html>