Author: Swift Geek <firstname.lastname@example.org>
Date: Tue, 6 Jun 2017 11:41:41 +0000
Merge branch 'www/various-website-improvements' of libreboot/libreboot into master
2 files changed, 37 insertions(+), 0 deletions(-)
diff --git a/www/contrib.md b/www/contrib.md
@@ -14,6 +14,13 @@ PHP. Additionally assisted with [booting
Linux](https://blog.rosenzweig.io/blobless-linux-on-the-pi.md) on the Raspberry
Pi without blobs. Current sysadmin and assists with project management.
+Works on large parts of Libreboot's build system and related documentation.
+Andrew joined the Libreboot project as part of core management on 4 June 2017.
+IRC nick `and_who` on #libreboot IRC.
diff --git a/www/git.md b/www/git.md
@@ -33,6 +33,31 @@ We currently have a shortage of people who possess the skill to write and
maintain good documentation for Libreboot, so we welcome any and all
+The .md files are written in Pandoc flavoured Markdown. The following scripts
+form Libreboot's *static site generator* which converts the Markdown files into
+HTML, to create the website:
+- index.sh: generates the news feed (on the News section of the website)
+- publish.sh: converts an .md file to an .html file
+- generate.sh: with calls to index.sh and publish.sh, compiles the entire
+ Libreboot website
+To view your local version of the website, it is advisable to install an HTTP
+server (e.g. nginx, lighttpd) and configure it so that the `www` directory in
+your local Git repository is the document root. With this, you can run
+`generate.sh` and view your own version of the website locally. This can be
+useful for larger changes (including structural) if you're making many large
+improvements to the website. However, it is possible to just edit the Markdown
+files with a text editor and submit those, or view individual .html files
+(generated by publish.sh) in a Web browser (e.g. Firefox).
+If you're running a local HTTP server, you can view your local version of the
+site by typing `localhost` into your browser's URL bar.
+At present, the site and documentation are optimized for use on the Web (as
+HTML, generated by Pandoc), but we would like to possibly support other use
+cases, such as PDF documents for printed manuals.
General guidelines for submitting patches
@@ -48,6 +73,11 @@ the *Creative Commons Zero* license is highly recommended. Otherwise, the **GNU
General Public License, version 3 or (at your option) any later version**, is
preferred; we will also accept any other free license.
+*We require all documentation and website changes to use the [GNU Free
+Documentation License, version 1.3](docs/fdl-1.3.md) or (at your option) any
+later version published by the Free Software Foundation; without Invariant
+sections, without front cover texts and without back cover texts.*
Libreboot development is facilitated by *[git](https://git-scm.com/)*, a
*distributed* version control system. You will need to install Git (most
GNU+Linux distributions package it in their repositories).