website rev 829

en: split devel/index.php into forge.php and clean up code (indent <p>)
author Christophe Lincoln <pankso@slitaz.org>
date Thu Apr 28 15:31:03 2011 +0200 (2011-04-28)
parents 51533419b5fe
children acf34ef74c4b
files en/devel/index.php fr/devel/index.html
line diff
     1.1 --- a/en/devel/index.php	Mon Apr 25 14:02:32 2011 +0100
     1.2 +++ b/en/devel/index.php	Thu Apr 28 15:31:03 2011 +0200
     1.3 @@ -75,251 +75,39 @@
     1.4  <h2>Devel corner</h2>
     1.5  
     1.6  <ul>
     1.7 -	<li><a href="#devel">SliTaz Developers corner.</a></li>
     1.8 -	<li><a href="#kiss">KISS and comply to standards.</a></li>
     1.9 -	<li><a href="#tank">Build host &amp; home.</a></li>
    1.10 -	<li><a href="#repos">Mercurial repositories.</a></li>
    1.11 -	<li><a href="#iconv">Implementation of iconv().</a></li>
    1.12 -	<li><a href="#pkgs">Tazpkg packages.</a></li>
    1.13 -	<li><a href="#website">Website Management.</a></li>
    1.14 +	<li><a href="forge.php">Forge</a> - Collaborative management, KISS,
    1.15 +	guideline, Mercurial repo, website and other services</li>
    1.16 +	<li><a href="../../i18n.php">Internationalisation project</a> -
    1.17 +    Translation, goals and management.</li>
    1.18  	<li><a href="http://hg.slitaz.org/" >Mercurial Repositories</a></li>
    1.19 -    <li><a href="http://labs.slitaz.org/">SliTaz Laboratories</a></li>
    1.20 +    <li><a href="http://bts.slitaz.org/">SliTaz Bugs Tracker</a></li>
    1.21  </ul>
    1.22  
    1.23  <a name="devel"></a>
    1.24 -<h2>SliTaz Developers corner</h2>
    1.25 +<h2>Get involved</h2>
    1.26  <p>
    1.27 -SliTaz is an open source and community driven distribution. Everyone is welcome 
    1.28 -to join and contribute, from  users, to hackers and developers, there is always
    1.29 -something to do, ie. Proofreading or writing documentation, sending bugs or 
    1.30 -patches to the Mailing list, gaining access to the wok and pushing some new 
    1.31 -packages or simply to help others on the Mailing list or forum. SliTaz has got
    1.32 -Mercurial repositories hosted on a SliTaz system, developers can ask for a new
    1.33 -repo if needed and contributors have write access to correct typos, scripts, etc.
    1.34 +	SliTaz is an open source and community driven distribution. Everyone is
    1.35 +	welcome to join and contribute, from  users, to hackers and developers,
    1.36 +	there is always something to do, ie. Proofreading or writing documentation,
    1.37 +	sending bugs or patches to the Mailing list, gaining access to the wok and
    1.38 +	pushing some new packages or simply to help others on the Mailing list or
    1.39 +	<a href="http://forum.slitaz.org/">forum</a>. SliTaz has got Mercurial
    1.40 +	repositories hosted on a SliTaz system, developers can ask for a new repo
    1.41 +	if needed and contributors have write access to correct typos, scripts, etc.
    1.42  </p>
    1.43  <p>
    1.44 -SliTaz is a tiny community and listens to its users. There are several 
    1.45 -developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
    1.46 -and the <a href="../mailing-list.html">Mailing List</a>.
    1.47 +	SliTaz is a tiny community and listens to its users. There are several 
    1.48 +	developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
    1.49 +	and the <a href="../mailing-list.html">Mailing List</a>.
    1.50  </p>
    1.51  <p>
    1.52 -For artists there is a dedicated website, simply create an account and 
    1.53 -post your graphics or pictures. The site is managed by the community. If 
    1.54 -you want to lend a hand to administer the site, please contact a 
    1.55 -contributor or e-mail the discussion list. Join the SliTaz Community 
    1.56 -<a href="http://scn.slitaz.org/groups/artwork/">Artwork group</a>
    1.57 +	For artists there is a dedicated website, simply create an account and 
    1.58 +	post your graphics or pictures. The site is managed by the community. If 
    1.59 +	you want to lend a hand to administer the site, please contact a 
    1.60 +	contributor or e-mail the discussion list. Join the SliTaz Community 
    1.61 +	<a href="http://scn.slitaz.org/groups/artwork/">Artwork group</a>
    1.62  </p>
    1.63  
    1.64 -<a name="kiss"></a>
    1.65 -<h2>KISS and comply to standards</h2>
    1.66 -<p>
    1.67 -Keep it simple: follow the best standards, carefully draft and write
    1.68 -high quality documentation, provide a stable and robust system and keep
    1.69 -the <em>rootfs</em> on the LiveCD light enough to run on machines with at 
    1.70 -least 128 MB RAM. It's also possible to use GTK+2, Dialog, SHell scripts, 
    1.71 -or PHP coding tools on the distribution. The idea is not to duplicate and 
    1.72 -to think small...
    1.73 -</p>
    1.74 -
    1.75 -<a name="tank"></a>
    1.76 -<h2>Tank - Build host &amp; home</h2>
    1.77 -<p>
    1.78 -Each contributor may have an account on the project server with secure 
    1.79 -access, disk space, a public directory and all development tools. 
    1.80 -Developers can compile packages and maintainers of the mirror can handle 
    1.81 -sychronization. Tank also hosts the website, web boot and mercurial 
    1.82 -repositories: <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
    1.83 -</p>
    1.84 -<p>
    1.85 -Instructions on using the build host are described in the Cookbook:
    1.86 -<a href="http://doc.slitaz.org/en:cookbook:buildhost">SliTaz Build Host (tank)</a>.
    1.87 -</p>
    1.88 -
    1.89 -<a name="repos"></a>
    1.90 -<h2>Mercurial repositories</h2>
    1.91 -<p>
    1.92 -SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using the URL:
    1.93 -<a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People with write
    1.94 -access can directly use <code>repos.slitaz.org</code> which requires authentication.
    1.95 -Mercurial uses Python and is installable with: 
    1.96 -<code>tazpkg get-install mercurial</code>
    1.97 -</p>
    1.98 -<h3>~/.hgrc</h3>
    1.99 -<p>
   1.100 -Before you push your first commit onto the server, be sure that you have a correct
   1.101 -Hg configuration file with your name and email address, and remember to check 
   1.102 -that you are not root. Personal ~/.hgrc file example:
   1.103 -</p>
   1.104 -<pre class="script">
   1.105 -[ui]
   1.106 -username = FirstName LastName &lt;you@example.org&gt;
   1.107 -</pre>
   1.108 -<h4>Clone, modify, commit and push</h4>
   1.109 -<p>
   1.110 -Clone a repo, example for wok:
   1.111 -</p>
   1.112 -<pre>
   1.113 - $ hg clone http://repos.slitaz.org/wok
   1.114 -</pre>
   1.115 -<p>
   1.116 -Change directory to wok, note you must be in the repository to be able 
   1.117 -to use 'hg' commands. To check all logs or just the last log:
   1.118 -</p>
   1.119 -<pre>
   1.120 - $ hg log
   1.121 - $ hg head
   1.122 -</pre>
   1.123 -<p>
   1.124 -Add or modify one or more files and commit:
   1.125 -</p>
   1.126 -<pre>
   1.127 - $ hg add
   1.128 - $ hg status
   1.129 - $ hg commit -m "Log message..."
   1.130 - $ hg log
   1.131 -</pre>
   1.132 -<p>
   1.133 -Note that you can use the command <code>rollback</code> to roll back to the last 
   1.134 -transaction. Before pushing changes to the server, it is safe to pull once:
   1.135 -</p>
   1.136 -<pre>
   1.137 - $ hg pull
   1.138 - $ hg push
   1.139 -</pre>
   1.140 -<p>
   1.141 -Done, your changes, code or corrections are now on the server.
   1.142 -</p>
   1.143 -<h4>Updating a local wok</h4>
   1.144 -<p>
   1.145 -To update your wok with the local server (<em>pull</em> to pull the changes):
   1.146 -</p>
   1.147 -<pre>
   1.148 - $ hg pull
   1.149 - $ hg update
   1.150 -</pre>
   1.151 -<h4>Useful commands</h4>
   1.152 -<p>
   1.153 -Hg commands that can be used.
   1.154 -</p>
   1.155 -<ul>
   1.156 -	<li><code>hg help</code> : Display the full list of commands.</li>
   1.157 -	<li><code>hg rollback</code> : Undo the last action performed (commit,
   1.158 -	pull, push).</li>
   1.159 -	<li><code>hg log &lt;package&gt;</code> : Display a package log.</li>
   1.160 -	<li><code>hg head</code> : Display the last log.</li>
   1.161 -</ul>
   1.162 -
   1.163 -<a name="iconv"></a>
   1.164 -<h2>Implementation of iconv()</h2>
   1.165 -<p>
   1.166 -SliTaz uses iconv() provided by GNU glibc - any packages that offer 
   1.167 -<code>libiconv</code> must use the library contained in <code>glibc-locale</code>. 
   1.168 -There is therefore no longer a libiconv package (1.2 MB) in SliTaz.
   1.169 -</p>
   1.170 -
   1.171 -<a name="pkgs"></a>
   1.172 -<h2>Tazpkg Packages</h2>
   1.173 -<p>
   1.174 -The tazpkg packages in SliTaz are automatically created via Tazwok and a 
   1.175 -receipt in the wok. The Cookbook describes the 
   1.176 -<a href="../doc/cookbook/wok-tools.html">use of tools</a> 
   1.177 -and the format of <a href="../doc/cookbook/receipts.html">receipts</a>.
   1.178 -These are required reading before we begin.
   1.179 -</p>
   1.180 -<p>
   1.181 -In terms of choice of package, the idea is to offer a package by task or 
   1.182 -functionality, ie. the lightest application in the field and not duplicated. 
   1.183 -Note that the current packages are not immutable, if you find an alternative 
   1.184 -that is lighter, with more features or more <em>sexy</em> for a few extra KB, 
   1.185 -you can suggest it on the Mailing List. Particular attention is given to 
   1.186 -packages for the LiveCD, these should be stripped, removing unnecesary 
   1.187 -dependancies and compiler options. In general candidate packages for the core 
   1.188 -LiveCD are discussed on the Mailing List.
   1.189 -</p>
   1.190 -<p>
   1.191 -Before you begin to compile and create packages for SliTaz, be sure that the 
   1.192 -work doesn't already exist in the 
   1.193 -<a href="http://download.tuxfamily.org/slitaz/packages/undigest/">undigest</a> 
   1.194 -wok provided by the primary SliTaz mirror. Don't forget that the members 
   1.195 -of the list are there to help you and that the documentation of the 
   1.196 -<a href="../doc/cookbook/wok-tools.html">wok and tools</a> 
   1.197 -exists to help you get started.
   1.198 -</p>
   1.199 -
   1.200 -<a name="pkgs-naming"></a>
   1.201 -<h3>Naming of packages</h3>
   1.202 -<p>
   1.203 -In most cases the package name is the same as the source, except for
   1.204 -Python, Perl, PHP, Ruby and Lua modules. For example, the package
   1.205 -providing a Kid template system written in Python and XML is named:
   1.206 -<code>python-kid</code>.
   1.207 -</p>
   1.208 -
   1.209 -<a name="website"></a>
   1.210 -<h2>Website Management</h2>
   1.211 -<p>
   1.212 -	The website is managed via a mercurial repository, they can be cloned by:
   1.213 -</p>
   1.214 -<pre>
   1.215 - $ hg clone http://hg.slitaz.org/website
   1.216 -  Or if you have the proper permissions:
   1.217 - $ hg clone http://repos.slitaz.org/website
   1.218 -</pre>
   1.219 -
   1.220 -<h3>xHTML coding style</h3>
   1.221 -<p>
   1.222 -The pages and different <em>books</em> are coded in xHTML 1.0
   1.223 -transitional. The title of level 1 is used only once (at the top), 
   1.224 -level 2 is the title of the document and levels 3 and 4 are then used for
   1.225 -the subtitles. If a list is used instead using smart anchors;
   1.226 -then that starts at the top, just after the title of level 2.
   1.227 -Paragraphs are contained in the tags <code>&lt;p&gt;&lt;/p&gt;</code>. 
   1.228 -For indentation, we use tabs - the reason being semantics and to take 
   1.229 -up less space in terms of octets (bytes). To put code, like the name of
   1.230 -a command inside a paragraph: <code>&lt;code&gt;</code> is the preferred 
   1.231 -method. To view commands or to utilize a terminal, the web pages use
   1.232 -<code>&lt;pre&gt;</code> to display the formatted text. Example:
   1.233 -</p>
   1.234 -<pre>
   1.235 - $ command
   1.236 -</pre>
   1.237 -<p>
   1.238 -To view text that can be copied and pasted, such as scripts,
   1.239 -bits of code, sample configuration files, etc - we also use
   1.240 -<code>&lt;pre&gt;</code>, but with a CSS class named "script". Example:
   1.241 -</p>
   1.242 -<pre class="script">
   1.243 -&lt;pre class="script"&gt;
   1.244 -
   1.245 -code...
   1.246 -
   1.247 -&lt;/pre&gt;
   1.248 -</pre>
   1.249 -<p>
   1.250 -The <em>emphasized</em> words put themselves in the tag <code>&lt;em&gt;</code> 
   1.251 -and internal links are relative. Remember to check the validity
   1.252 -of the code via the online <em>validator</em> of the W3C.
   1.253 -</p>
   1.254 -
   1.255 -<a name="diff"></a>
   1.256 -<h2>Diff and patch</h2>
   1.257 -<p>
   1.258 -The utilities <code>diff</code> and <code>patch</code> are command-line tools 
   1.259 -for creating and implementing a file containing differences between two files. 
   1.260 -This technique is often used for collaboration and the changes made to the 
   1.261 -original file can be clearly extracted. To create a <code>diff</code> file 
   1.262 -readable by humans in a simple text editor, you must supply the <code>-u</code> option:
   1.263 -</p>
   1.264 -<pre>
   1.265 - $ diff -u file.orig file.new &gt; file.diff
   1.266 -</pre>
   1.267 -<p>
   1.268 -To apply a patch:
   1.269 -</p>
   1.270 -<pre>
   1.271 - $ patch file.orig file.diff
   1.272 -</pre>
   1.273 -
   1.274  <!-- End of content -->
   1.275  </div>
   1.276  
     2.1 --- a/fr/devel/index.html	Mon Apr 25 14:02:32 2011 +0100
     2.2 +++ b/fr/devel/index.html	Thu Apr 28 15:31:03 2011 +0200
     2.3 @@ -102,7 +102,7 @@
     2.4  du Handbook pour rédiger votre texte et l'envoyer par mail sur la
     2.5  <a href="../mailing-list.html">mailing list</a> pour relecture et discussion
     2.6  ou la soumettre sur les laboratoires du projet. 
     2.7 -<a href="http://labs.slitaz.org/">Les Labs</a> vous permettent aussi de 
     2.8 +<a href="http://scn.slitaz.org/">SCN</a> vous permettent aussi de 
     2.9  suivre le projet, d'aider à résoudre des bugs ou satisfaire des demandes,
    2.10  d'envoyer des fichiers, scripts ou page du site.
    2.11  </p>