The branch, master has been updated via 430c08fa8c350b23e3468530e29d59d70e8d9fa2 (commit) from 82464b46678e32b780f69b5b5d2fc4e0e694d0dd (commit)
- Log ----------------------------------------------------------------- commit 430c08fa8c350b23e3468530e29d59d70e8d9fa2 Author: Michal Čihař michal@cihar.com Date: Sun Feb 5 14:43:30 2012 +0100
Rewrite contribute page
It now just lists options with few details and points users to more detailed page. The devel page would definitely need more attention.
-----------------------------------------------------------------------
Summary of changes: render.py | 2 +- templates/devel.tpl | 104 +++++++++++++++++++++++++++++++++++ templates/improve.tpl | 138 ++++++++++------------------------------------- templates/translate.tpl | 37 +++++++++++++ 4 files changed, 170 insertions(+), 111 deletions(-) create mode 100644 templates/devel.tpl create mode 100644 templates/translate.tpl
diff --git a/render.py b/render.py index f5df112..b630e84 100755 --- a/render.py +++ b/render.py @@ -833,7 +833,7 @@ class SFGenerator: elif page in ['index', 'news']: priority = '1.0' changefreq = 'daily' - elif page in ['improve', 'team', 'docs']: + elif page in ['improve', 'team', 'docs', 'devel', 'translate']: priority = '1.0' changefreq = 'weekly' elif page in ['downloads', 'donate', 'themes', 'translations']: diff --git a/templates/devel.tpl b/templates/devel.tpl new file mode 100644 index 0000000..7e18f9d --- /dev/null +++ b/templates/devel.tpl @@ -0,0 +1,104 @@ +<html xmlns:py="http://genshi.edgewall.org/" xmlns:xi="http://www.w3.org/2001/XInclude" py:strip=""> + +<py:def function="page_title">Developing phpMyAdmin</py:def> + +<div py:match="content" id="body"> + +<h2>Developing phpMyAdmin</h2> + +<p> +phpMyAdmin is (as the name says) written in PHP and uses MySQL. Besides this, +we also need people skilled in HTML, JavaScript and CSS, as these are parts +which make our user interface. You don't have to be expert in all these areas +- even knowing only one of them, you can still provide substantial help in +creating or debugging some features. +</p> + +<p> +For storing our code we use <a href="http://git-scm.com/">Git</a>. +If you don't know it, you can get some basic facts in <a +href="http://en.wikipedia.org/wiki/Git_software%22%3EWikipedia</a> or +reference in the comprehensive book <a href="http://progit.org/">Pro Git</a>. +</p> + +<p> +You can find more information for developers on our +<a href="http://wiki.phpmyadmin.net/pma/Development">wiki</a>. +</p> + +<h3>Contributing code</h3> +<p> +Once you have coded an improvement and you are ready to submit it to us, +please use our <a +href="https://sourceforge.net/tracker/?group_id=23067&atid=377410%22%3Epatch +tracker</a>, where developers will pick up your contributions or guide you +through improving the patch. +</p> + +<h3>Simple tasks to start</h3> +<p> +If you are looking for some simple task where you can start, check out +our wiki page with <a href="http://wiki.phpmyadmin.net/pma/Tasks_for_junior_developers">junior +jobs</a> where you can find some tips where to look. +</p> + +<h3>Source Code Repository</h3> +<xi:include href="_gitdl.tpl" /> + +<p> +You want to start with the <code>phpmyadmin</code> repository. +Full list of repositories include: +</p> + +<dl class="cvslist"> +<dt>phpmyadmin</dt><dd>phpMyAdmin code.</dd> +<dt>website</dt><dd>Website code.</dd> +<dt>themes</dt><dd>Custom themes.</dd> +<dt>data</dt><dd>Various project related data (such as logos, T-shirt graphics, etc.).</dd> +<dt>history</dt><dd>Some historical documents (old changelogs or website).</dd> +<dt>planet</dt><dd><a href="http://planet.phpmyadmin.net/">Planet phpMyAdmin</a> configuration.</dd> +<dt>localized_docs</dt><dd>Localized documentation.</dd> +</dl> + +<p> +Examples of how to checkout phpMyAdmin code: +</p> + +<pre> +# Latest development version: +git clone git://phpmyadmin.git.sourceforge.net/gitroot/phpmyadmin/phpmyadmin +</pre> + +<h3>Repository Statistics</h3> +<p>Several statistics about the repository are available:</p> +<ul> +<li><a href="http://cia.vc/stats/project/phpmyadmin/">CIA.vc</a></li> +<li><a href="http://www.ohloh.net/projects/phpmyadmin">Ohloh</a></li> +<li><a href="https://sourceforge.net/project/stats/detail.php?group_id=23067&ugn=phpmyadmin&type=git">SourceForge.net</a></li> +</ul> + +<h3>Coding Standards</h3> +<p> +Standards should be obeyed in all cases when possible. Generated content +should be valid XHTML 1.0 and CSS. PHP code should match <a +href="http://pear.php.net/manual/en/standards.php%22%3EPEAR Coding Standards</a> +and documented using <a href="http://www.phpdoc.org/">phpDocumentator</a>. +More information about coding is available on <a href="http://wiki.phpmyadmin.net/pma/Coding_guidelines"> +our wiki</a>. +</p> + +<h3>Developer Documentation</h3> + +<p>More documentation can be found in the following places:</p> +<ul> +<li><a href="http://wiki.phpmyadmin.net/pma/Development">Developers wiki</a></li> +<li><a href="http://www.phpmyadmin.net/phpdoc/">phpMyAdmin's internals +(autogenerated via phpDocumentator)</a></li> +</ul> + + +</div> + +<xi:include href="_page.tpl" /> +</html> + diff --git a/templates/improve.tpl b/templates/improve.tpl index 4e8750f..3ad2258 100644 --- a/templates/improve.tpl +++ b/templates/improve.tpl @@ -12,138 +12,56 @@ need developer skills to help, there are several non-coding ways to get involved in a project (code is welcome too, of course!). </p>
-<p>Ways in which you can contribute:</p> -<ul> - <li><a href="#devel">program</a> new features,</li> - <li>report <a href="http://sourceforge.net/tracker/?atid=377408&group_id=23067">bugs</a> (errors in the program),</li> - <li>debug existing features,</li> - - <li>improve documentation or the <a href="http://wiki.phpmyadmin.net/">wiki</a>,</li> - <li><a href="#translate">translate phpMyAdmin</a> to your own language,</li> - <li><a href="#translate">translate the documentation</a>,</li> - <li>help other users on <a href="https://sourceforge.net/forum/?group_id=23067">forums</a>,</li> - - <li>distribute phpMyAdmin,</li> - <li><a href="${base_url}donate.${file_ext}">donate money</a> to the project,</li> -</ul> - -<p>As you can see, everyone can help.</p> - -<h2><a id="devel"></a>Developing</h2> - -<p> -phpMyAdmin is (as the name says) written in PHP and uses MySQL. Besides this, -we also need people skilled in HTML, JavaScript and CSS, as these are parts -which make our user interface. You don't have to be expert in all these areas -- even knowing only one of them, you can still provide substantial help in -creating or debugging some features. -</p> - -<p> -For storing our code we use <a href="http://git-scm.com/">Git</a>. -If you don't know it, you can get some basic facts in <a -href="http://en.wikipedia.org/wiki/Git_software%22%3EWikipedia</a> or -reference in the comprehensive book <a href="http://progit.org/">Pro Git</a>. -</p> +<h3>Helping users</h3>
<p> -You can find more information for developers on our -<a href="http://wiki.phpmyadmin.net/pma/Development">wiki</a>. +Interested in helping other users to use phpMyAdmin? You can join any of +<a href="${base_url}support.${file_ext}">support</a> we provide and help users - +there IRC, mailing lists and web forums, where you can share your experience. </p>
-<h3>Contributing code</h3> -<p> -Once you have coded an improvement and you are ready to submit it to us, -please use our <a -href="https://sourceforge.net/tracker/?group_id=23067&atid=377410%22%3Epatch -tracker</a>, where developers will pick up your contributions or guide you -through improving the patch. -</p> +<h3 id="translate">Localization</h3>
-<h3>Simple tasks to start</h3> <p> -If you are looking for some simple task where you can start, check out -our wiki page with <a href="http://wiki.phpmyadmin.net/pma/Tasks_for_junior_developers">junior -jobs</a> where you can find some tips where to look. +phpMyAdmin is being translated to many languages, but maybe your language is not +really up to date? You can easily contribute on our +<a href="https://l10n.cihar.com/projects/phpmyadmin/">translation server</a>. +You can find out more on <a href="${base_url}translate.${file_ext}">separate +page</a>. </p>
-<h3>Source Code Repository</h3> -<xi:include href="_gitdl.tpl" /> +<h3>Testing and quality assurance</h3>
<p> -You want to start with the <code>phpmyadmin</code> repository. -Full list of repositories include: +One of important things is to avoid problems in user interface. You can really help +us here to provide feedback on releases and especially by testing pre-releases +(alpha/beta/rc) we provide for testing. Just download them and <a href="http://sourceforge.net/tracker/?atid=377408&group_id=23067">report any issues</a> +you face with them. </p>
-<dl class="cvslist"> -<dt>phpmyadmin</dt><dd>phpMyAdmin code.</dd> -<dt>website</dt><dd>Website code.</dd> -<dt>themes</dt><dd>Custom themes.</dd> -<dt>data</dt><dd>Various project related data (such as logos, T-shirt graphics, etc.).</dd> -<dt>history</dt><dd>Some historical documents (old changelogs or website).</dd> -<dt>planet</dt><dd><a href="http://planet.phpmyadmin.net/">Planet phpMyAdmin</a> configuration.</dd> -<dt>localized_docs</dt><dd>Localized documentation.</dd> -</dl> +<h3>Documentation writer</h3>
<p> -Examples of how to checkout phpMyAdmin code: +Do you feel our documentation misses some points? We welcome additions here +just let us know your changes. Should you know git, you can directly send patches or +merge requests, but this is not strictly necessary. </p>
-<pre> -# Latest development version: -git clone git://phpmyadmin.git.sourceforge.net/gitroot/phpmyadmin/phpmyadmin -</pre> +<h3 id="devel">Developing</h3>
-<h3>Repository Statistics</h3> -<p>Several statistics about the repository are available:</p> -<ul> -<li><a href="http://cia.vc/stats/project/phpmyadmin/">CIA.vc</a></li> -<li><a href="http://www.ohloh.net/projects/phpmyadmin">Ohloh</a></li> -<li><a href="https://sourceforge.net/project/stats/detail.php?group_id=23067&ugn=phpmyadmin&type=git">SourceForge.net</a></li> -</ul> - -<h3>Coding Standards</h3> <p> -Standards should be obeyed in all cases when possible. Generated content -should be valid XHTML 1.0 and CSS. PHP code should match <a -href="http://pear.php.net/manual/en/standards.php%22%3EPEAR Coding Standards</a> -and documented using <a href="http://www.phpdoc.org/">phpDocumentator</a>. -More information about coding is available on <a href="http://wiki.phpmyadmin.net/pma/Coding_guidelines"> -our wiki</a>. +Coding contriubtions are very welcome, the easiest way is to for our code on github +and submit a merge request. We really welcome bug fixes or new features. +You can find out more on <a href="${base_url}devel.${file_ext}">separate +page</a>. </p>
-<h3>Developer Documentation</h3> - -<p>More documentation can be found in the following places:</p> -<ul> -<li><a href="http://wiki.phpmyadmin.net/pma/Development">Developers wiki</a></li> -<li><a href="http://www.phpmyadmin.net/phpdoc/">phpMyAdmin's internals -(autogenerated via phpDocumentator)</a></li> -</ul> - -<h2><a id="translate"></a>Translating</h2> - -<p> -For localization, phpMyAdmin uses Gettext, you can find po files for each -translation in <code>po</code> directory in phpMyAdmin sources. You can -translate them using usual tools for handling Gettext translations or use our -<a href="https://l10n.cihar.com/projects/phpmyadmin/">translation server</a>. -More information about translating can be found in -<a href="http://www.phpmyadmin.net/documentation/#faq7_2">FAQ 7.2</a>. The more -detailed documentation can be found on our <a href="http://wiki.phpmyadmin.net/pma/Translating">wiki</a>. -</p> +<h3>Fund our project</h3>
<p> -Documentation is being translated using po4a and gettext (see <a -href="${base_url}docs.${file_ext}">documentation</a> for existing -translations). To start, checkout <code><a -href="http://phpmyadmin.git.sourceforge.net/git/gitweb.cgi?p=phpmyadmin/localized_...</a></code> from Git, or -just go to <a href="https://l10n.cihar.com/projects/pmadoc/">translation -server</a> and translate it online. If your language is missing, just contact -<a href="mailto:michal@cihar.com">Michal Čihař</a>, he will add it. If you -prefer to translate directly the po files, please put updated ones into our <a -href="https://sourceforge.net/tracker/?group_id=23067&atid=387645%22%3Etransla... -tracker</a>. +We need money to allow our presence on conferences, buy new hardware or provide various +useful services to our users and developpers. By <a href="${base_url}donate.${file_ext}">donating</a> +you help us in this area and possibly increase our presence on conferences. </p>
</div> diff --git a/templates/translate.tpl b/templates/translate.tpl new file mode 100644 index 0000000..1d4f2e0 --- /dev/null +++ b/templates/translate.tpl @@ -0,0 +1,37 @@ +<html xmlns:py="http://genshi.edgewall.org/" xmlns:xi="http://www.w3.org/2001/XInclude" py:strip=""> + +<py:def function="page_title">Translating phpMyAdmin</py:def> + +<div py:match="content" id="body"> + +<h2>Translating phpMyAdmin</h2> + +<p> +For localization, phpMyAdmin uses Gettext, you can find po files for each +translation in <code>po</code> directory in phpMyAdmin sources. You can +translate them using usual tools for handling Gettext translations or use our +<a href="https://l10n.cihar.com/projects/phpmyadmin/">translation server</a>. +More information about translating can be found in +<a href="http://www.phpmyadmin.net/documentation/#faq7_2">FAQ 7.2</a>. The more +detailed documentation can be found on our <a href="http://wiki.phpmyadmin.net/pma/Translating">wiki</a>. +</p> + +<p> +Documentation is being translated using po4a and gettext (see <a +href="${base_url}docs.${file_ext}">documentation</a> for existing +translations). To start, checkout <code><a +href="http://phpmyadmin.git.sourceforge.net/git/gitweb.cgi?p=phpmyadmin/localized_...</a></code> from Git, or +just go to <a href="https://l10n.cihar.com/projects/pmadoc/">translation +server</a> and translate it online. If your language is missing, just contact +<a href="mailto:michal@cihar.com">Michal Čihař</a>, he will add it. If you +prefer to translate directly the po files, please put updated ones into our <a +href="https://sourceforge.net/tracker/?group_id=23067&atid=387645%22%3Etransla... +tracker</a>. +</p> + +</div> + +<xi:include href="_page.tpl" /> +</html> + +
hooks/post-receive