Websites/workflow

From FedoraProject

< Websites(Difference between revisions)
Jump to: navigation, search
m (Actual used branches for each (sub)domain)
m (Update to correct Transifex URLs, use https, new help center URLs.)
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{ Admon/warning | In progress. Any help appreciated. | This is a start page for a detailed Websites team presentation. You can edit freely.}}
 
 
 
__TOC__
 
__TOC__
  
Line 8: Line 6:
 
Our websites are rebuilt hourly. This is done using the syncStatic script which is puppet managed. In other words, you need to be on the infra team to change it. A sample copy is uploaded [http://shaiton.fedorapeople.org/web/syncStatic.sh there]. This is where we decide against which branch we build each websites. There is also a specific syncStatic.stg script for the staging websites. Example of stg websites are stg.fedoraproject.org and spins.stg.fedoraproject.org.  
 
Our websites are rebuilt hourly. This is done using the syncStatic script which is puppet managed. In other words, you need to be on the infra team to change it. A sample copy is uploaded [http://shaiton.fedorapeople.org/web/syncStatic.sh there]. This is where we decide against which branch we build each websites. There is also a specific syncStatic.stg script for the staging websites. Example of stg websites are stg.fedoraproject.org and spins.stg.fedoraproject.org.  
  
For release time, please refer to our specific documentation [http://infrastructure.fedoraproject.org/infra/docs/fedorawebsites.txt there].
+
For release time, please refer to our specific documentation [http://infrastructure.fedoraproject.org/infra/docs/fedorawebsites.txt there]. We have also a document which helps you [[Websites/workflow/checklist|not to forget anything]] when merging to the next release version.
 +
 
 +
==== Usage ====
 +
To build the static websites pages you can run ''make'' from the specific website root directory. This will build the pages in all available languages. A list of all existing translations is available in the header of the Makefile.<br />
 +
This kind of building is rather long, if you want you can run also:
 +
* ''make LANG'': builds the pages in a specific language, where LANG is the two-letter abbreviation for the translation.
 +
* ''make LANG test'': builds a test instance at http://localhost:5000/ in a specific language, run '''make stoptest''' to take it down.
 +
* ''make test'': same as above, will build a test instance for all available languages.
  
 
=== Coding ===
 
=== Coding ===
''insert graph here''
+
Many of our websites are using the [http://960.gs/ 960 Grid System] which is why you will see many divs on our HTML sources. You might want to see an [http://960.gs/demo.html explanation].
 +
 
 
==== Architecture ====
 
==== Architecture ====
There is a specific folder for each websites under which you will find the following tree:
+
The fedora-web repository looks like the following (mostly all websites use the same tree as boot.fedoraproject.org).
  
    .
+
  .
    |-- boot.fedoraproject.org
+
  |-- boot.fedoraproject.org
    |  |-- build
+
  |-- data
    |  |-- ChangeLog
+
  |  |-- Makefile
    |  |-- data
+
  |  |-- po
    |  |-- httpd
+
  |  `-- static
    |  |-- Makefile
+
  |-- build.d
    |  |-- po
+
  |  |-- buildconf.py
    |  `-- static
+
  |  |-- build.py
    `-- TODO
+
  |  |-- construct-translations.py
 +
  |  |-- globalvar.py
 +
  |  |-- pybabel.cfg
 +
  |  `-- translations.ini
 +
  …
 +
  |-- httpd
 +
  |-- Makefile.in
 +
  `-- tools
  
There are several folders, one for each websites. The main one have the same tree: a build folder where we have some python scripts for Genshi, the Makefile which is used to run the build, po which hold the translation files, data who has some templates and the HTML sources (in data/content/), and static where are some static files (pictures, JS scripts, CSS..).
+
Each websites directory consists on a <code>data</code> folders holding HTML code, while all static code (JS, pictures, CSS…) are in <code>static</code>. Some websites use specific building files in the <code>build</code> dir if any.
The httpd folder is used to set a local apache server in order to run a testing instance.
+
<code>build.d</code> contains the python building scripts and the Genshi template, as well as the language name localized for each luangages.
 +
The <code>httpd</code> folder contains standalone apache files to locally test our websites.
 +
<code>tools</code> is the place for manual script that we run times to time. In order to update the <code>LINGUAS</code> file, or to check the websites..
  
 
==== i18n ====
 
==== i18n ====
Line 36: Line 51:
 
# <code>${_('String')}</code>
 
# <code>${_('String')}</code>
 
# <code>${Markup(_('String with &amp;gt; html code'))}</code>
 
# <code>${Markup(_('String with &amp;gt; html code'))}</code>
# <code>${Markup(_('String with a &amp;lt;a href="%s"&amp;gt;link&amp;lt;/a&amp;gt;') % 'http://fedoraproject.org')}</code>
+
# <code><nowiki>${Markup(_('String with a &amp;lt;a href="%s"&amp;gt;link&amp;lt;/a&amp;gt;') % 'http://fedoraproject.org')}</nowiki></code>
 
# <code>${_('%(size)s, DVD ISO disc image for %(arch)s-bit PC') % {'size':'3.1 GB', 'arch':'32'}}</code>
 
# <code>${_('%(size)s, DVD ISO disc image for %(arch)s-bit PC') % {'size':'3.1 GB', 'arch':'32'}}</code>
 +
# <code><nowiki>${Markup(_('If you think you\'ve found a bug, read &lt;a href="%s"&gt;here&lt;/a&gt; fist.') % ('http://fedoraproject.org/wiki/Common_F'+global_variables.release['prev_id']+'_bugs'))}</nowiki></code>
  
 
Fist you have the simplest example. Then the markup that could be used everywhere (it works with embedded html code, not as the first one). Then, you have an example using a variable. That is really useful in order to avoid having translators to translate again the string when changing the variable. The last example is a most complete one which shows you how to deal with multiple variables. The translator will be able to change the variable order using it's name.
 
Fist you have the simplest example. Then the markup that could be used everywhere (it works with embedded html code, not as the first one). Then, you have an example using a variable. That is really useful in order to avoid having translators to translate again the string when changing the variable. The last example is a most complete one which shows you how to deal with multiple variables. The translator will be able to change the variable order using it's name.
Line 44: Line 60:
  
 
Once it's correct, you need to generate the new translation template file (POT) with <code>make pot</code>.
 
Once it's correct, you need to generate the new translation template file (POT) with <code>make pot</code>.
 +
 +
For general information about Genshi templates, see:
 +
* http://genshi.edgewall.org/wiki/Documentation, and in particular,
 +
* http://genshi.edgewall.org/wiki/Documentation/xml-templates.html
 +
 +
===== Variables =====
 +
As described in the examples above, you will note there are a lot of variables instead of hard codes. These variables have been set to make it easier to update our webpages. When merging from one branch to the next, i.e. from beta to final release, all the content of our pages can be updated by editing simply one single file, where all the variables are defined.<br />
 +
This file actually is used in the sites of ''fedoraproject.org'' and in ''spins.fedoraproject.org'' and is located in <code>~/build.d/globalvar.py</code>
  
 
=== l10n ===
 
=== l10n ===
All POs are download hourly. Any error should be reported to our [https://fedorahosted.org/fedora-websites/newticket tracking system].
+
All POs are download twice a day. Any error should be reported to our [https://fedorahosted.org/fedora-websites/newticket tracking system].
 +
We download only the files translated at least at 10%. Please note that you won't be able to proofread only if you didn't get this far. This value is [http://git.fedorahosted.org/cgit/fedora-web.git/tree/Makefile.in#n66 Makefile.in] for the local test and in puppet/syncTranslation.sh for the online
 +
websites.
  
 
Whenever the HTML content change, we need to update the POT as explained on the previous section. Then, we need to push this POT to the translation platform, [http://fedora.transifex.com/ transifex.com]. This is done by the command <code>make pushpot</code>. But only the maintainers of the [https://fedora.transifex.com/projects/p/fedora-web/ fedora-web] release are able to push a new POT. Ask them if you need to do so. Please, open a new ticket.
 
Whenever the HTML content change, we need to update the POT as explained on the previous section. Then, we need to push this POT to the translation platform, [http://fedora.transifex.com/ transifex.com]. This is done by the command <code>make pushpot</code>. But only the maintainers of the [https://fedora.transifex.com/projects/p/fedora-web/ fedora-web] release are able to push a new POT. Ask them if you need to do so. Please, open a new ticket.
  
 +
In order to know if the builder is actually pulling the translations in a specific branch/website, check on the [http://git.fedorahosted.org/cgit/fedora-web.git/tree/ repo] if a file named <code>PO_FREEZE</code> exists on the website folder. This could be used while editing the Transifex POT without overriding the existing translations on production.
  
If you need to add a new language, you need to update the LINGUAS file, the translation.py file, and the languages.conf file.
+
Adding a new language is done through 4 steps:
 
+
# first, create it at transifex.com by uploading a new translation on the website.
Here is the tree:
+
# Then, update the <code>translations.ini</code> file accordingly
    .
+
# update the <code>LINGUAS</code> file (<code>tools/l10N_update.sh</code> might be of help)
    |-- boot.fedoraproject.org
+
# update the local <code>httpd/conf/language.conf</code> file (by running <code>make en test</code> for example) and ask to make this change in the infra (puppet). That is probably needed as we have the same exact copy of this file there. File a ticket for that on our [https://fedorahosted.org/fedora-websites/newticket?type=enhancement&summary=adding%20new%20locale%20to%20puppet&keywords=infra,%20l10n Trac].
    |  |-- build
+
    |  |      `-- translations.py
+
    |  |-- httpd
+
    |  |      `-- conf
+
    |  |              `-- languages.conf.in
+
    |  `-- po
+
    |        `--LINGUAS
+
    `-- l10N_update.sh
+
 
+
The script "l10N_update.sh" could be used to generate a new LINGUAS file as well as to upload a new POT and to backup the PO files. There is a redesign on going in order to automatize this, and have only one translation.py and languages.conf.in files. This is ticket [https://fedorahosted.org/fedora-websites/ticket/90 #90].
+
 
+
== The Hot (comming) New Websites Arch ==
+
 
+
The idea is to have a different tree using a recursive make. The syncStatic script will have few changes. Like the following (not sure about the httpd folder)
+
 
+
  .
+
  |-- boot.fedoraproject.org
+
  |  |-- build
+
  |  |-- data
+
  |  |-- httpd
+
  |  |-- Makefile
+
  |  |-- po
+
  |  `-- static
+
  …
+
  |-- build
+
  |-- Makefile
+
  |-- static
+
  |-- templates
+
  `-- TODO
+
 
+
 
+
This is directly related to ticket [https://fedorahosted.org/fedora-websites/ticket/90 #90]. To help, get in touch with shaiton.
+
  
 
== Joining/helping ==  
 
== Joining/helping ==  
Line 94: Line 89:
 
== Actual used branches for each (sub)domain ==
 
== Actual used branches for each (sub)domain ==
  
This overview should help you to understand which git-branch is used to build a single subdomain or domain. <br />
+
All our websites in production now are build against master branch. This makes it much easier to contributors to push their commits to the right branch. Staging websites on the other hand are build against the actual developing ''release-state'' branch: this could be alpha or beta, but in some cases can also be a specific branch. In fact we use the staging (stg) branch for specific enhancements, this allows us to keep the alpha or beta branch clean.<br />
Usually the subdomains are build with master-branch, while the main fedoraproject domain and the spins are build with the 'release-state' branch.
+
The new workflow means we will merge every single development branch to master at D-day, as production sites are build only against master branch.<br />
 +
This overview should help you to understand which git-branch is used to build a single subdomain or domain.
  
 
{|
 
{|
Line 101: Line 97:
 
| '''Domain''' ||'''Branch'''
 
| '''Domain''' ||'''Branch'''
 
|-
 
|-
| fedoraproject.org || f18-beta
+
| [http://fedoraproject.org fedoraproject.org] || master
|-
+
| stg.fedoraproject.org || arch-redesign
+
|-
+
| spins.fedoraproject.org || f18-beta
+
 
|-
 
|-
| spins.stg.fedoraproject.org || f18-beta
+
| [http://stg.fedoraproject.org stg.fedoraproject.org] || f19-alpha
 
|-
 
|-
| boot.fedoraproject.org || master
+
| [http://spins.fedoraproject.org spins.fedoraproject.org] || master
 
|-
 
|-
| fedoracommunity.org || master
+
| [http://spins.stg.fedoraproject.org spins.stg.fedoraproject.org] || f19-alpha
 
|-
 
|-
| fedorahosted.org || master
+
| [http://boot.fedoraproject.org boot.fedoraproject.org] || master
 
|-
 
|-
| fedorapeople.org || master
+
| [http://fedoracommunity.org fedoracommunity.org] || master
 
|-
 
|-
| fudcon.fedoraproject.org || master
+
| [http://fedorahosted.org fadorahosted.org] || master
 
|-
 
|-
| mirrors.fedoraproject.org || master
+
| [http://fedorapeople.org fedorapeople.org] || master
 
|-
 
|-
| serverbeach1.fedoraproject.org || master
+
| [http://fudcon.fedoraproject.org fudcon.fedoraproject.org] || master
 
|-
 
|-
| start.fedoraproject.org || master
+
| [http://start.fedoraproject.org start.fedoraproject.org] || master
 
|-
 
|-
| talk.fedoraproject.org || master
 
 
|}
 
|}

Revision as of 02:41, 9 April 2013

Contents


The websites arch (build, dev and trans)

Our build system

Our websites are rebuilt hourly. This is done using the syncStatic script which is puppet managed. In other words, you need to be on the infra team to change it. A sample copy is uploaded there. This is where we decide against which branch we build each websites. There is also a specific syncStatic.stg script for the staging websites. Example of stg websites are stg.fedoraproject.org and spins.stg.fedoraproject.org.

For release time, please refer to our specific documentation there. We have also a document which helps you not to forget anything when merging to the next release version.

Usage

To build the static websites pages you can run make from the specific website root directory. This will build the pages in all available languages. A list of all existing translations is available in the header of the Makefile.
This kind of building is rather long, if you want you can run also:

  • make LANG: builds the pages in a specific language, where LANG is the two-letter abbreviation for the translation.
  • make LANG test: builds a test instance at http://localhost:5000/ in a specific language, run make stoptest to take it down.
  • make test: same as above, will build a test instance for all available languages.

Coding

Many of our websites are using the 960 Grid System which is why you will see many divs on our HTML sources. You might want to see an explanation.

Architecture

The fedora-web repository looks like the following (mostly all websites use the same tree as boot.fedoraproject.org).

  .
  |-- boot.fedoraproject.org
  |   |-- data
  |   |-- Makefile
  |   |-- po
  |   `-- static
  |-- build.d
  |   |-- buildconf.py
  |   |-- build.py
  |   |-- construct-translations.py
  |   |-- globalvar.py
  |   |-- pybabel.cfg
  |   `-- translations.ini
  …
  |-- httpd
  |-- Makefile.in
  `-- tools

Each websites directory consists on a data folders holding HTML code, while all static code (JS, pictures, CSS…) are in static. Some websites use specific building files in the build dir if any. build.d contains the python building scripts and the Genshi template, as well as the language name localized for each luangages. The httpd folder contains standalone apache files to locally test our websites. tools is the place for manual script that we run times to time. In order to update the LINGUAS file, or to check the websites..

i18n

We use the Genshi framework for internationalization. Our current templates need to have special markup around the strings in order to mark them as translatable.

There are several way to use the markups.

  1. ${_('String')}
  2. ${Markup(_('String with &gt; html code'))}
  3. ${Markup(_('String with a &lt;a href="%s"&gt;link&lt;/a&gt;') % 'http://fedoraproject.org')}
  4. ${_('%(size)s, DVD ISO disc image for %(arch)s-bit PC') % {'size':'3.1 GB', 'arch':'32'}}
  5. ${Markup(_('If you think you\'ve found a bug, read <a href="%s">here</a> fist.') % ('http://fedoraproject.org/wiki/Common_F'+global_variables.release['prev_id']+'_bugs'))}

Fist you have the simplest example. Then the markup that could be used everywhere (it works with embedded html code, not as the first one). Then, you have an example using a variable. That is really useful in order to avoid having translators to translate again the string when changing the variable. The last example is a most complete one which shows you how to deal with multiple variables. The translator will be able to change the variable order using it's name.

To test that you haven't missed anything (for example you need to escape the simple quote from the string), try with make en test in order to build the website for the en language.

Once it's correct, you need to generate the new translation template file (POT) with make pot.

For general information about Genshi templates, see:

Variables

As described in the examples above, you will note there are a lot of variables instead of hard codes. These variables have been set to make it easier to update our webpages. When merging from one branch to the next, i.e. from beta to final release, all the content of our pages can be updated by editing simply one single file, where all the variables are defined.
This file actually is used in the sites of fedoraproject.org and in spins.fedoraproject.org and is located in ~/build.d/globalvar.py

l10n

All POs are download twice a day. Any error should be reported to our tracking system. We download only the files translated at least at 10%. Please note that you won't be able to proofread only if you didn't get this far. This value is Makefile.in for the local test and in puppet/syncTranslation.sh for the online websites.

Whenever the HTML content change, we need to update the POT as explained on the previous section. Then, we need to push this POT to the translation platform, transifex.com. This is done by the command make pushpot. But only the maintainers of the fedora-web release are able to push a new POT. Ask them if you need to do so. Please, open a new ticket.

In order to know if the builder is actually pulling the translations in a specific branch/website, check on the repo if a file named PO_FREEZE exists on the website folder. This could be used while editing the Transifex POT without overriding the existing translations on production.

Adding a new language is done through 4 steps:

  1. first, create it at transifex.com by uploading a new translation on the website.
  2. Then, update the translations.ini file accordingly
  3. update the LINGUAS file (tools/l10N_update.sh might be of help)
  4. update the local httpd/conf/language.conf file (by running make en test for example) and ask to make this change in the infra (puppet). That is probably needed as we have the same exact copy of this file there. File a ticket for that on our Trac.

Joining/helping

Please read the Websites/Join and How to fix bugs pages.

Actual used branches for each (sub)domain

All our websites in production now are build against master branch. This makes it much easier to contributors to push their commits to the right branch. Staging websites on the other hand are build against the actual developing release-state branch: this could be alpha or beta, but in some cases can also be a specific branch. In fact we use the staging (stg) branch for specific enhancements, this allows us to keep the alpha or beta branch clean.
The new workflow means we will merge every single development branch to master at D-day, as production sites are build only against master branch.
This overview should help you to understand which git-branch is used to build a single subdomain or domain.

Domain Branch
fedoraproject.org master
stg.fedoraproject.org f19-alpha
spins.fedoraproject.org master
spins.stg.fedoraproject.org f19-alpha
boot.fedoraproject.org master
fedoracommunity.org master
fadorahosted.org master
fedorapeople.org master
fudcon.fedoraproject.org master
start.fedoraproject.org master