2021-12-11 11:32:00 +01:00
|
|
|
% Translations wanted
|
2021-12-11 11:03:42 +01:00
|
|
|
% Leah Rowe
|
|
|
|
|
% 11 December 2021
|
|
|
|
|
|
2021-12-11 11:06:15 +01:00
|
|
|
The libreboot website is currently only available in English.
|
2021-12-11 11:03:42 +01:00
|
|
|
|
2021-12-11 11:06:15 +01:00
|
|
|
I've recently added support for translations to
|
2021-12-11 11:03:42 +01:00
|
|
|
the [Untitled Static Site Generator](https://untitled.vimuser.org/), which the
|
2022-11-22 22:09:52 +01:00
|
|
|
Libreboot website uses. Pages on libreboot.srht.site are written in Markdown, and
|
2021-12-11 11:03:42 +01:00
|
|
|
this software generates HTML pages.
|
|
|
|
|
|
|
|
|
|
This very page that you are reading was created this way!
|
|
|
|
|
|
2021-12-11 11:06:15 +01:00
|
|
|
Getting started
|
|
|
|
|
===============
|
|
|
|
|
|
2021-12-11 11:03:42 +01:00
|
|
|
The Libreboot website is available, in Markdown, from a Git repository:\
|
|
|
|
|
<https://notabug.org/libreboot/lbwww>
|
|
|
|
|
|
|
|
|
|
Instructions for how to send patches are available here:\
|
2022-11-22 22:09:52 +01:00
|
|
|
<https://libreboot.srht.site/git.html>
|
2021-12-11 11:03:42 +01:00
|
|
|
|
|
|
|
|
If you're working on a translation, make note of the commit ID from `lbwww.git`
|
|
|
|
|
and keep track of further changes (to the English website) in that repository.
|
|
|
|
|
|
|
|
|
|
When you send the translation, please specify what commit ID in `lbwww.git` it
|
|
|
|
|
is up to date with. From then on, I will keep track of changes to the English
|
|
|
|
|
website, which is what I work on. My native language is English. When the first
|
2022-11-22 22:09:52 +01:00
|
|
|
translation is made available on libreboot.srht.site, I will create a new page (in
|
2021-12-11 11:03:42 +01:00
|
|
|
English only), and add notes to it whenever I make site changes, and show
|
|
|
|
|
where these changes need to then be performed in translated versions of each
|
|
|
|
|
page that I change.
|
|
|
|
|
|
2022-11-22 22:09:52 +01:00
|
|
|
How to translate libreboot.srht.site
|
2021-12-11 11:03:42 +01:00
|
|
|
==============================
|
|
|
|
|
|
|
|
|
|
The documentation on <https://untitled.vimuser.org/> tells you how to handle
|
|
|
|
|
translations.
|
|
|
|
|
|
|
|
|
|
I recommend that you set up a local Nginx HTTP server on your computer, and
|
|
|
|
|
configure Untitled for it, using the instructions on the Untitled website. This
|
|
|
|
|
will make it easier to see what your translated website looks like, before it
|
|
|
|
|
goes live.
|
|
|
|
|
|
2021-12-11 11:25:30 +01:00
|
|
|
**It is recommended that you install a firewall, if you're running Nginx,
|
|
|
|
|
unless you actually want it to be publicly accessible. The `ufw` software is
|
|
|
|
|
quite nice:**
|
|
|
|
|
|
|
|
|
|
sudo apt-get install ufw
|
|
|
|
|
sudo ufw enable
|
|
|
|
|
|
|
|
|
|
This will block all unsolicited incoming traffic. It's good practise anyway,
|
|
|
|
|
for workstations. You don't have to use ufw, but it's a nice frontend for
|
|
|
|
|
iptables/ip6tables on systems that use the Linux kernel. More information
|
|
|
|
|
about `ufw` available here:
|
|
|
|
|
|
|
|
|
|
<https://help.ubuntu.com/community/UFW>
|
|
|
|
|
|
|
|
|
|
When viewing your local website, you can just type `http://localhost/` in your
|
|
|
|
|
browser. This will resolve to your local loopback address.
|
|
|
|
|
|
2021-12-11 12:10:20 +01:00
|
|
|
In general, you will be working with `md` files and `include` files.
|
2021-12-11 11:03:42 +01:00
|
|
|
Keep an eye out for files with `template`, `footer` and `nav` in the name.
|
|
|
|
|
More information about how Untitled works is available on the Untitled
|
|
|
|
|
website. You should also add a translated `strings.cfg` file to Untitled, for
|
|
|
|
|
your translation, if Untitled doesn't support it.
|
|
|
|
|
|
|
|
|
|
You can add pages in any language to Untitled. The software automatically
|
|
|
|
|
generates language selection menus, on a per-page basis, when a translation is
|
|
|
|
|
available for a given page.
|
