Permalink
Browse files

second commit

  • Loading branch information...
1 parent e011990 commit e8943c9a962b1f4498446f2c0682906013eb4495 @peterbe committed Oct 10, 2011
Showing with 672 additions and 3 deletions.
  1. +590 −0 all.svg
  2. BIN databasediagram.png
  3. BIN databasediagram_1000x945.png
  4. +8 −3 index.rst
  5. +8 −0 l10nstats.rst
  6. +20 −0 life.rst
  7. +39 −0 overview.rst
  8. +7 −0 shipping.rst
View
590 all.svg

Large diffs are not rendered by default.

Oops, something went wrong.
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -15,15 +15,21 @@ localizers to navigate to get stuff done.
This documentation is about the `elmo django application
<https://github.com/mozilla/elmo>`_ and how it works and why it works
-like it works.
+like it works.
+All code is available here: https://github.com/mozilla/elmo
+
+The production is available here: https://l10n-stage-sj.mozilla.org/
Contents:
.. toctree::
:maxdepth: 2
-
+
+ overview
life
+ shipping
+ l10nstats
Indices and tables
@@ -32,4 +38,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-
View
@@ -0,0 +1,8 @@
+.. index:: l10nstats
+
+.. _l10nstats-chapter:
+
+L10nstats
+=========
+
+
View
@@ -10,3 +10,23 @@ app that defines the most fundamental models of elmo. It basically
reflects the state of translation work done and to be done. All other
applications depend on this app for interactions.
+Let's delve into some of the key models:
+
+Locale
+------
+
+Key fields:
+
+* ``code`` - e.g. "nn-NO"
+* ``name`` - e.g. "Norweigian (Nynorsk)"
+* ``native`` - e.g. "Norsk nynorsk"
+
+Every repository and every shipping signoff references a locale. It's
+
+Changeset
+---------
+
+Key fields:
+
+* ``revision`` - e.g. "9b2a99adc05e53cd4010de512f50118594756650"
+* (TODO: any more "key" fields here?)
View
@@ -0,0 +1,39 @@
+.. index:: overview
+
+.. _overview-chapter:
+
+Overview
+========
+
+.. image:: databasediagram_1000x945.png
+
+(image originally from http://people.mozilla.org/~axel/all.svg)
+
+
+As you can see in this database diagram, Elmo consists of 3 major parts:
+
+* :ref:`life-chapter`
+* :ref:`shipping-chapter`
+* :ref:`l10nstats-chapter`
+
+Their names imply what they each do and deal with. There are other
+various tools that aren't directly part of these major apps but are
+also important. For example, the privacy app (TODO: figure out whether
+to bother documenting this).
+
+Basically the whole database model is based around the structure that
+is used in Mozilla to develop Firefox, Thunderbird, etc. but instead
+of source code to the running programs, it's definition files
+containing translatable strings. An example of a translatable string
+file can for example look like this::
+
+ <!-- Tab context menu -->
+ <!ENTITY reloadTab.label "Oppdater fane">
+ <!ENTITY reloadTab.accesskey "O">
+ <!ENTITY reloadAllTabs.label "Oppdater alle fanene">
+ <!ENTITY reloadAllTabs.accesskey "d">
+ <!ENTITY closeOtherTabs.label "Lat att andre faner">
+ <!ENTITY closeOtherTabs.accesskey "a">
+
+(this is the `Norwegian (nn-NO) source for browser.dtd
+<http://hg.mozilla.org/l10n-central/nn-NO/file/d2b41af23354/browser/chrome/browser/browser.dtd>`_)
View
@@ -0,0 +1,7 @@
+.. index:: shipping
+
+.. _shipping-chapter:
+
+Shipping
+========
+

0 comments on commit e8943c9

Please sign in to comment.