From: Michael McMahon <michael@fsf.org>
Date: Thu, 28 Mar 2024 15:28:19 +0000 (-0400)
Subject: Reformatting project goals and moved links to the end.
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=35c228436041945ec1ef42555c6e3ce4da1447e4;p=history-fsf.git

Reformatting project goals and moved links to the end.
---

diff --git a/README.md b/README.md
index da7942b..2924929 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,45 @@
 # FSF History page
 
-This is a timeline project to chronicle the historical events surrounding the Free Software Foundation.
+This is a timeline project to chronicle the historical events surrounding the
+Free Software Foundation.
 
-* Development link: <https://static.fsf.org/nosvn/demos/history-static/>
-* Production link: <https://www.fsf.org/history/>
-* The original image we are drafting from: common/fundraising/biannual-fundraisers/2020-fall/timeline/ (Internal location)
-* [Member Forum post with comments](https://forum.members.fsf.org/t/fsf-history-page/3701)
-* [[!rt 1748452]] RT ticket about adding fsfe, fsff, fsfi, and fsfla logos. (Internal location)
+Link to production site: https://www.fsf.org/history/
+
+## Project description
+
+We have a [final page](https://www.fsf.org/history/),
+[source and picture files](https://www.fsf.org/history/fsf-history.tar.gz),
+a markdown file, and a
+[translation](https://flallemand.fr/divers/fsf-history/).
+
+### Goals
+
+- Generate the history page from source.
+  - Generate the https://www.fsf.org/history/index.html file from our source
+    file in MarkDown or JSON format using a simple scripting language
+    (BASH/Python preferably). Basically this would involve creating a simple
+    custom static site generator. Below is the syntax used by the source file.
+    - The source is currently in ikiwiki MarkDown format, but it is not a
+      traditional MarkDown document as it would need to be rendered in the way
+      that the history page currently is displayed. Maybe converting the
+      markdown to JSON would be a good first step.
+- Internationalization (i18n)
+  - Create a method to convert the history page
+    https://www.fsf.org/history/index.html to various other languages. A French
+    translation might be rendered to https://www.fsf.org/history/fr/index.html
+    URL for example.
+    - This could be converting the rendered HTML to po with html2po and then
+      gettext to make new versions.
+      - Example command converting HTML to a po file: `sudo apt install translate-toolkit && wget https://www.fsf.org/history/index.html && html2po index.html > messages.po`
+      - <http://docs.translatehouse.org/projects/translate-toolkit/en/latest/commands/html2po.html>
+    - We currently have a French translation in HTML format, but we would need
+      to convert this into a reproducable format that works with whatever
+      system we decide to use.
+- Automatically generate new pages.
+  - On the server-side, we would need a simple BASH script that is run by an
+    automated cron job that fetches new changes from this repository and builds
+    the pages with the new changes if necessary and creates new translations
+    when available.
 
 ## Syntax
 
@@ -70,22 +103,17 @@ Syntax description:
   - Optional.
   - Text for the link.  We typically just use `Read more >` for this.
 
-## Project description
-
-We have a [final page](https://www.fsf.org/history/),
-[source and picture files](https://www.fsf.org/history/fsf-history.tar.gz),
-a markdown file, and a
-[translation](https://flallemand.fr/divers/fsf-history/).
-
-Ideally, we need a way to generate the final output from the
-markdown file and add translations. Basically, a custom static site generator
-with translation support.
-
-I am picturing git for version control, cron for automation, some basic
-scripting language to make one to the other (BASH/Python preferably), and a
-program to convert po to other languages like https://www.fsf.org/history/fr
-URL format.
+## Links
 
 Some of the reference locations are only accessible to internal staff. I tried
 to mark all of those.  I might have missed pictures, but they should be linked
 from the production site.
+
+* Development link: <https://static.fsf.org/nosvn/demos/history-static/>
+* Production link: <https://www.fsf.org/history/>
+* The original image we are drafting from:
+  common/fundraising/biannual-fundraisers/2020-fall/timeline/ (Internal
+  location)
+* [Member Forum post with comments](https://forum.members.fsf.org/t/fsf-history-page/3701)
+* <https://rt.gnu.org/Ticket/Display.html?id=1748452> (Internal location) RT
+  ticket about adding fsfe, fsff, fsfi, and fsfla logos.