From 2258cbeb7bf12ada8b8d0f5c0996d7cc4aa27818 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 30 May 2017 01:02:51 +0100 Subject: Add edit link to all pages, linking to instructions for sending patches This is necessary, so that people know how to modify the website and send improvements, like they do on wiki sites. Although Libreboot is git-hosted, having this link helps. It goes to a section added to the Git page, instructing users how to edit the website and documentation. --- www/footer.md | 1 + www/git.md | 22 ++++++++++++++++++++++ www/publish.sh | 4 ++-- 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/www/footer.md b/www/footer.md index be252407..30dea43b 100644 --- a/www/footer.md +++ b/www/footer.md @@ -1,4 +1,5 @@ +**[Edit this page](/git.md#editing-the-website-and-documentation-wiki-style)** -- [License](/docs/fdl-1.3.md) -- [Template](/license.md) -- [Authors](/contrib.md) -- diff --git a/www/git.md b/www/git.md index a1ddd993..f6ebab77 100644 --- a/www/git.md +++ b/www/git.md @@ -11,6 +11,28 @@ Download Libreboot from the Git repository here: **git clone https://notabug.org/libreboot/libreboot.git** +Editing the website and documentation, wiki-style +------------------------------------------------- + +The entire website on libreboot.org, including all of the Libreboot +documentation, is hosted in the Git repository. The pages are written in +Markdown, which is an easy-to-use markup language similar to the one used +when, for instance, editing pages on WikiPedia or a MediaWiki-based website. + +Just download Libreboot's Git repository, make changes to the website under +the ***www*** directory. Changes to the documentation section are made under +the ***docs*** directory. Once you've made your changes, you can submit them +for inclusion live on libreboot.org, using the instructions on the rest of this +page. + +***You can use any standard text editor to edit and improve the entire +Libreboot website. E.g. Vim, GNU Emacs, GNU Nano, Gedit or whatever you +prefer to use.*** + +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! + General guidelines for submitting patches ----------------------------------------- diff --git a/www/publish.sh b/www/publish.sh index fb891458..606c1fc9 100755 --- a/www/publish.sh +++ b/www/publish.sh @@ -38,7 +38,7 @@ if [ "${FILE}" != "./index" ]; then DEST="./" fi - RETURN="Back to previous index" + RETURN="Edit this page -- Back to previous index" OPTS="-T Libreboot" fi else @@ -46,7 +46,7 @@ else fi if [[ $FILE = *suppliers ]]; then - printf "\nBack to previous index\n" >> temp.md + printf "\nEdit this page -- Back to previous page\n" >> temp.md fi if [ "${FILE}" != "./docs/fdl-1.3" ] && [ "${FILE}" != "./conduct" ]; then -- cgit v1.2.3-70-g09d2