The previous configuration was more complicated and required two steps each
time one tried to deploy the website. The new configuration makes use of
the ProxyJump feature to allow deploying in only one step.
Signed-off-by: Adrien 'neox' Bourmault <neox@gnu.org>
The information on who maintains GNU Boot is already in git.md, and
having duplicate information increase maintenance costs, here for no
known benefits.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
We add that information in "Send patches & contribute" as contributors
also need to understand the workflow, to know if their patch is being
accepted, if they need to do something special or not, need to wait,
etc.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The script isn't related to flashrom. The comment was already in the
first lbmk commit 89517ed6b9
("libreboot!") which was based on osboot and at the time it didn't
contain any flashrom related code either.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
When we already have the right untitled revision checked out, we don't
need to try to fetch its revision again. This also enable offline
builds in that case.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The 'TODO' link was pointing to an old page that is currently not up-to-date
so this commit replaces that link by another, to the Savannah forge main page.
Signed-off-by: Adrien 'neox' Bourmault <neox@gnu.org>
The 'Bugs' link in the template was pointing to the old bug reporting page of
our previous project. This commit makes it pointing to the Savannah bug
reporting system used by GNU Boot.
Signed-off-by: Adrien 'neox' Bourmault <neox@gnu.org>
Since we now have a very visible banner that indicates which pages
have been not been reviewed, and contribution instructions on how to
fix that, we are ready to publish the website.
Right now the deploy path of the website isn't configurable as this
would require some form of templating or processing of the markdown
files, so the website was simply moved from
gnu.org/software/gnuboot/test to gnu.org/software/gnuboot.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
This uses a black background and white text which is the opposite of
the default theme. By using black and white, this also makes sure that
color blind people can still see the banner.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
GNU Boot might have to send some of the patches upstream so we can't
have a policy that applies to everything unless we also look into
upstream projects and GNU policies as well.
In addition we might need multiple ways to satisfy upstream
constraints to fit different needs / compromise from people wanting to
contribute anonymously.
And as the problem raised here is more global it is better to have a
more global answers and find ways that also work with upstream projects
as well.
Being a GNU project, GNU boot would also need to look into the GNU
policies on the topic and also try to see if for instance the FSF
copyright assignements could also be used in some cases to fix that
issue.
There are also other things worth looking into as well. For instance
Software Conservancy also handles copyright assignments and Asahi Lina
that contributes anonymously to the Linux kernel while satisfying
their very strict policy about tracking copyright ownership.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
It makes more sense to report test success / failure to the bug
mailing list because there are already similar reports in our bug
tracking system and also because this doesn't need to send any
patches.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Reported-by: Adrien 'neox' Bourmault <neox@gnu.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
In Parabola, the libreboot-utils and various u-boot packages needed
Libreboot as it was providing deblobbed source releases of Coreboot
and u-boot.
Because of that and also because I need also deblobbed u-boot for Guix
and Replicant, I ended up being involved in Libreboot.at and then GNU
Boot.
However the Replicant project also needs my help, so when joining
Libreboot.at and then GNU Boot I mostly wanted to have a project I
could rely on and be able to easily send patches to it.
So the idea was that once the project would be in a good shape I would
reconsider if I still needed to be a maintainer and try to see if new
contributors wanted to replace me (to have more than one maintainers)
and then go back sending patches from time to time as a regular
contributor to have more time for other projects.
This is why we used the word "interim" at the beginning: I was not
sure (and still am not sure) to want to stay maintainer of GNU Boot
forever. Adrien however has other plans.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
People probably want to have first a very short description of the
project and then its status before knowing the project history.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
This commit addresses a problem in the wording of our project description
(in the Savannah description and in this README.md).
The project description was re-written from scratch by GNUtoo and this
commits import it unmodified from Savannah[1]. It is also released by
GNUtoo under the following license:
Copyright (c) 2023 Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
[1]https://savannah.gnu.org/projects/gnuboot
Reported-by: Patrick Georgi <oxygene>
Neox: import, commit message apart from the copyright information.
GNUtoo: copyright information, whitespace fixes.
Signed-off-by: Adrien 'neox' Bourmault <neox@gnu.org>
For some reasons having both 'x-reviewed: true' and 'x-toc-enable:
true' results in having the following content on the top-right of the
page:
title: Code
review
x-toc-
enable:
true
x-reviewed:
true
Return to
index
…
GNU Boot
repositories
Since using the Untitled static website generator is meant to be
temporary, fixing this issue is not a priority right now.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
If we are in test/web the links work fine but if we go in
test/web/docs/, the links are relative to the current page and stop
working.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
If we are in test/web the links work fine but if we go in
test/web/docs/, the links are relative to the current page and stop
working.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
For some reasons having both 'x-reviewed: true' and 'x-toc-enable:
true' results in having the following content on the top-right of the
page:
title: Code
review
x-toc-
enable:
true
x-reviewed:
true
Return to
index
…
GNU Boot
repositories
Since using the Untitled static website generator is meant to be
temporary, fixing this issue is not a priority right now.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Using simply 'git log' or 'git show' shows the author but not the
commiter.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The new untitled revision has a fix for having spaces inside the
website title.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Before we needed to fetch the website from git because it was in a
separate repository.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, we end up with 'Fix SC2086 (info): Double quote to
prevent globbing and word splitting.' shellcheck warnings.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, using shellcheck on this file results in several warning
like this one:
In website-build/build.sh line 101:
if [ $i -ge $# ] ; then
^-- SC2086 (info):
Double quote to prevent
globbing and word splitting.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, using shellcheck on this file results in this
warning:
In website-build/check.sh line 56:
nr_files=$(tar tf "${tarball}" | grep -v '/' | wc -l)
^---------^ SC2126 (style):
Consider using
'grep -c' instead of 'grep|wc -l'.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, using shellcheck on this file results in several warning
like this one:
In website-build/build.sh line 32:
echo -e "\t-h, --help"
^-- SC3037 (warning):
In POSIX sh, echo flags are undefined.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, using shellcheck on this file results in this
warning:
In website-build/check.sh line 58:
if [ ${nr_files} -eq 1 ] ; then
^---------^ SC2086 (info):
Double quote to prevent globbing and word splitting.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, using shellcheck on this file results in several warning
like this one:
In website-build/check.sh line 27:
echo -e "\t-h, --help"
^-- SC3037 (warning):
In POSIX sh, echo flags are undefined.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Without that fix, clicking to Download will go to
https://gnu.org/download.html.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The build.sh script currently hardcodes the repository URL and
revisions or branches name it uses.
If contributors aren't aware of that they could end up testing a
revision that is different from the one that they are working on.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The website and documentation originally comes from Libreboot and
Libreboot didn't have separate website and documentation.
And we need to reuse it because without it, GNU Boot would be almost
useless as without documentation most users would not be able to
install it.
The website is about 900 files and consist in about 27 MiB of
pictures.
Given that the website is not ready yet and that we are looking for
contributions to help us fixing it, we will end up having to update it
often, and ideally in a timely manner as well not to discourage
contributions.
So we needed some way to deployment the website with very few
commands.
GNU typically use CVS for deploying the website, but it is harder to
use than rsync for automatizing the deployment of a website.
To do that someone would have to write or adapt code to do the
deployment automatically, but that can potentially be time consuming
to do, especially if it needs to be done efficiently (for instance by
only adding files that changed since the last time) not to load too
much the CVS server.
Because of all that, an rsync access was temporarily setup for us, to
enable us to publish the website now and to be able to fixing this
deployment issue later and/or ask for help on the website to fix it.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Guix is being used to build the website and Guix has the 'guix deploy'
command, so this should look more familiar to people using Guix.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Most GNU projects use a CVS repository to publish their web pages.
For some reasons, in the CVS root directory (inside the gnuboot CVS
module) the only file that we can add is index.html. Subdirectories
don't have this limitation.
So we add a test for that.
In addition when the website will be ready we will most likely have an
html file that redirect to a subdirectory (like /web/) and so we add
the html file for doing that too.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Since the website and the images were merged in GNU boot respectively
in site/ and www/, we can now modify GNU boot to only be cloned once
to build the website.
The image path was also modified to make images work both in the local
served website and at gnu.org and also to minimize the differences
between the test and deployment setups.
Libreboot.at also hosted a copy of Untitled to make it simple to
control the revision being used.
But in the longer term, it would be a bad idea to do that again for
GNU boot since there are plans to convert the website and/or
documentation to the texinfo format, and so at some point Untitled
will stop being used, and we don't want to end up with a git
repository that needs to be kept for historic reasons but that is
unused.
Since the website isn't ready we also have a redirection to Savannah
to make sure that visitors are redirected to something meaningful.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Neox: Suggested the split in smaller commits and various ways to do
that (including some that were used).
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The website will be published to https://gnu.org/software/gnuboot. But
for now it is not ready yet to be published as-is because there are no
contribution instructions yet and we also need to agree on what to put
on the main page.
So until that's fixed, it will be published to
https://gnu.org/software/gnuboot/test.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Neox: Suggested the split from the "website-build: build.sh: switch to
GNU Boot repositories." commit.
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Since the website and the images were merged in GNU boot respectively
in site/ and www/, we can now modify GNU boot to only be cloned once
to build the website.
This also requires to move the images inside site/ at the place where
website-build expects them.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Neox: Suggested the split from the "website-build: build.sh: switch to
GNU Boot repositories." commit.
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
This for instance enable users to manually override the revisions to
test branches of git repositories.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Having that code inside the same repository than GNU Boot makes it
easier to keep Untitled versions (and possibly additional patches on
top) in sync with the documentation/website being worked on.
This is relevant as there are plans within GNU Boot to convert the
website to Texinfo but that would require to patch untitled (to add
support for Texinfo pages in untitled) to do a progressive transition
to Texinfo.
Using an external repository to temporarily maintain a patched version
of Untitled is not optimal as we would end up having to warn users not
to use that repository anymore at some point.
Bringing in the whole untitled source code and documentation in this
GNU Boot repository is also not a good option since we only need
minimal patching on top of untitled, so in the long run not doing that
would help keep the GNU Boot repository smaller and more simple.
In addition we currently do need to wrap the build with a fixed Guix
revision as for instance with a more recent Guix revision than the one
used by website-built, for instance at the commit ("gnu: nyxt: Update
to 3.9.0."), if we run ./build.sh directly without using a fixed Guix
revision, the build is broken:
Generating 'www/lbwww/site/index.html'
Generating 'www/lbwww/site/license.html'
YAML parse exception at line 7, column 0,
while scanning a simple key:
could not find expected ':'
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The documentation/website pictures are currently in a separate
repository, but they are needed to build the documentation/website.
Since we want to be able to have commits that modify both the code and
the documentation, including its pictures in order to keep everything
in sync, we need to merge both histories.
It's also a good idea to do that as early as possible as we don't need
to deal with the confusion of having to keep an extra unused git
repository for historic purposes.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
The website and the documentation are currently in a separate
repository.
Since we want to be able to have commits that modify both the code and
the documentation in order to keep everything in sync, we need to
merge both histories.
It's also a good idea to do that as early as possible as we don't need
to deal with the confusion of having to keep an extra unused git
repository for historic purposes.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien 'neox' Bourmault <neox@gnu.org>
Now there are probably too much people to thank to have all that on
the main page.
If we want to keep their names, a better idea would be to collect all
their names and add them to the release announcement.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
For the GNU Boot website and documentation we reused:
- The Libreboot website as it contains a lot of documentation
(installation instructions, documentation on supported computers,
etc). And we don't want to re-do all that from scratch.
- The libreboot.at website as some of its modifications (like the
ability to include images from the same domain, the fact that it
mention that it's not libreboot.org, etc) are useful to us, and here
too it's a good idea not to have to re-do all that work from
scratch.
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
