[Freedombox-discuss] Move ~fbx/README to wiki.debian.org?

Petter Reinholdtsen pere at hungry.com
Mon Mar 24 13:12:26 UTC 2014


According to Nick on #freedombox, the README currently placed in
~fbx/README is the user documentation for the freedombox, and placed
there in v0.1 as the fbx user was the entry point when users started
looking at the freedombox.  This is no longer the case, as the plinth
web interface is the entry point now.

In Debian Edu, we store the documentation on wiki.debian.org, and via
docbook handle translations and transformations to HTML and PDF
version of the user manual.  I suggest we do the same in the
FreedomBox project, and transform the ~fbx/README file to one or more
wiki pages under <URL: https://wiki.debian.org/FreedomBox/Manual/Jessie/ >.
It will lower the bar for new contributors and allow us to work with
the manual in docbook or markdown format as we see fit.

This way the documentation can then be either used directly from
wiki.debian.org or transformed into documentation presented via the
Plinth web interface.

Any objections?  Any volunteers willing to make it happen?

See <URL: https://wiki.debian.org/DebianEdu/Documentation/Wheezy >
and the debian-edu-doc debian package to see how Debian Edu handle the
manual.

-- 
Happy hacking
Petter Reinhodltsen



More information about the Freedombox-discuss mailing list