From c6e9a94a94836e34535f369604027ebb2d7aeb70 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 6 Jun 2017 11:58:36 +0100 Subject: Add Andrew Robbins to the Authors page --- www/contrib.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/www/contrib.md b/www/contrib.md index b1089a39..2322157e 100644 --- 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. +Andrew Robbins +-------------- + +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. + Arthur Heymans -------------- -- cgit v1.2.3-70-g09d2 From 5b32e553b96e7971099f82ed209ea4e8ada2d196 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 6 Jun 2017 12:07:07 +0100 Subject: git page: further document Libreboot's static site generator This is useful for people who want to work on much larger changes to the Web site or documentation. --- www/git.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/www/git.md b/www/git.md index f6ebab77..44644ec3 100644 --- a/www/git.md +++ b/www/git.md @@ -33,6 +33,28 @@ 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 contributions! +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). + +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 aswell, such as PDF documents for printed manuals. + General guidelines for submitting patches ----------------------------------------- -- cgit v1.2.3-70-g09d2 From 95da20481ae39c85c4bc21a5948b426c2113d34a Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 6 Jun 2017 12:12:37 +0100 Subject: git page: Mention that documentation must be contributed under GNU FDL --- www/git.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/www/git.md b/www/git.md index 44644ec3..39440a09 100644 --- a/www/git.md +++ b/www/git.md @@ -70,6 +70,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). -- cgit v1.2.3-70-g09d2 From 3b0fb2b74ea8e21decab8b46b4991c557008b710 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 6 Jun 2017 12:18:03 +0100 Subject: git page: mention that local web server is accessible via localhost --- www/git.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/www/git.md b/www/git.md index 39440a09..3c4605d3 100644 --- a/www/git.md +++ b/www/git.md @@ -51,6 +51,9 @@ 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 aswell, such as PDF documents for printed manuals. -- cgit v1.2.3-70-g09d2 From 6e4bd65054c463910a65a5cf8942225a351519e9 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 6 Jun 2017 12:36:30 +0100 Subject: git page: per swiftgeek's suggestion, fix grammar on git page --- www/git.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/git.md b/www/git.md index 3c4605d3..8c17ea54 100644 --- a/www/git.md +++ b/www/git.md @@ -56,7 +56,7 @@ 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 aswell, such as PDF documents for printed manuals. +cases, such as PDF documents for printed manuals. General guidelines for submitting patches ----------------------------------------- -- cgit v1.2.3-70-g09d2