public inbox for gentoo-project@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-project] Gentoo Handbooks moving to the wiki
@ 2014-12-12 15:30 Sven Vermeulen
  2014-12-12 15:44 ` Manuel Rüger
                   ` (2 more replies)
  0 siblings, 3 replies; 28+ messages in thread
From: Sven Vermeulen @ 2014-12-12 15:30 UTC (permalink / raw
  To: gentoo-project

Hi all

The last few days I have been spamming #gentoo-wiki with numerous edits,
translation tagging, new pages, and so on, with the main goal to copy the
current Gentoo Linux handbooks to the Gentoo Wiki. Before doing the last
steps (i.e. updating links and marking the current handbooks as obsoleted) I
thought about informing the broader development community about the change.

You might ask "why move them to the wiki?" (or perhaps you just say "about
time" - in that case ignore the next few paragraphs and jump immediately to
"what is the result" further down in the mail ;-), well let me tell why.

First of all, the Gentoo Handbooks were the only user-oriented documents
that the Gentoo Documentation Project "manages" that were not on the Gentoo
Wiki yet. And although 'back in the days' the choice for the XML-based
documentation development was valid (offline development of documentation
was a primary concern) times have changed, as well as documentation
developer abilities.

The need to train users into the dark corners of GuideXML (and the almost
programmatic approach to the Gentoo Handbooks) pushes down hard on the
team's growth. And that in essence is the second reason as well: the Gentoo
Documentation Project is no longer the huge project it once was. We reduced
from over 20 authors/editors to only one or two active members - and even
those do not do it "full time" anymore. Moving towards a better known (and
popular) documentation platform makes sense.

Any request to update the handbook (we have a few bugs open on it) had to be
taken by those few documentation developers, whereas with the move to the wiki,
I hope that other developers would take up the opportunity to update the
documentation themselves. Especially for the architecture teams who would
like to update the Gentoo Handbooks with their specific installation
instructions will this be a blessing (I hope). Also the developers in charge
of the "additional sections" of the handbook, such as networking, can now
help update and maintain the documentation.

A third reason is that the current website runs an XSLT parser to transform
the documentation into HTML. The Gentoo Handbook being in GuideXML kept on
hindering any progress on the website development and future as it was a
blocker for potential infrastructural changes. With the move to the Gentoo
Wiki, this is one less concern to think about.

Of course, consolidating all documentation (including the handbook) to the
wiki provides a common platform for Gentoo's documentation development and
single writing style. And it gives a universal look and feel to the
documentation, instead of having two different views (GuideXML rendering and
Wiki rendering look different), which hopefully puts a bit less confusion to
the users.

An advantage is also that the links to the Gentoo Handbook become a bit
simpler. Consider the link to configuring GRUB2 for AMD64:

Current handbook:
https://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?part=1&chap=10#doc_chap2
Wiki handbook:
https://wiki.gentoo.org/wiki/Handbook:AMD64/Installation/Bootloader#Default:_Using_GRUB2

Although a tad longer, the link is much more readable, and when pasted on
things like IRC users can immediately see what it is about.

So, what is the result of this move?

The various handbooks are available in their own namespace (with thanks to
Alex Legler for creating it as well as supporting the move):

https://wiki.gentoo.org/wiki/Handbook:Alpha
https://wiki.gentoo.org/wiki/Handbook:AMD64
https://wiki.gentoo.org/wiki/Handbook:HPPA
https://wiki.gentoo.org/wiki/Handbook:IA64
https://wiki.gentoo.org/wiki/Handbook:MIPS
https://wiki.gentoo.org/wiki/Handbook:PPC
https://wiki.gentoo.org/wiki/Handbook:PPC64
https://wiki.gentoo.org/wiki/Handbook:SPARC
https://wiki.gentoo.org/wiki/Handbook:X86

If I am not mistaken, these locations should be editable by developers and
trusted contributors (and if not yet then that is the idea to implement).

All handbooks use the same structure. In effect, there is lots of re-use of
documentation snippets (as was the case with the Gentoo Handbooks in
GuideXML). Although I did not implement the same "programming-like"
documentation development as was done with the GuideXML ones, the wikified
Gentoo Handbook uses transclusion (inclusion of other pages) and Semantic
MediaWiki for the dynamic generation and changes of documentation.

Unless people object heavily, I will start updating the GuideXML handbooks
to redirect the users to the wiki handbooks, as well as update the links on
the website and wiki articles.

Note that, when moved, the translations might take some time to catch up.
This is because the translated information (in GuideXML) cannot be easily
moved towards the wiki (with the move, texts have been updated as well to
reflect the wiki writing style), and because the wiki uses a translation
extension that supports parallel translation development - but different
than how GuideXML translations worked.

Users interested in the "development" side (what are the reused parts and so
on) can feed their lusts on
https://wiki.gentoo.org/wiki/Project:Documentation/HandbookDevelopment

I hope this is a start of many updates and improvements. Feedback is always
welcome of course.

With kind regards

	Sven Vermeulen
	aka SwifT


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-12 15:30 [gentoo-project] Gentoo Handbooks moving to the wiki Sven Vermeulen
@ 2014-12-12 15:44 ` Manuel Rüger
  2014-12-12 17:00   ` Sven Vermeulen
  2014-12-13 13:05 ` Alexander Berntsen
  2014-12-20 21:40 ` Tom Wijsman
  2 siblings, 1 reply; 28+ messages in thread
From: Manuel Rüger @ 2014-12-12 15:44 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

On 12.12.2014 16:30, Sven Vermeulen wrote:
> Hi all
> 
> The last few days I have been spamming #gentoo-wiki with numerous
> edits, translation tagging, new pages, and so on, with the main
> goal to copy the current Gentoo Linux handbooks to the Gentoo Wiki.
> Before doing the last steps (i.e. updating links and marking the
> current handbooks as obsoleted) I thought about informing the
> broader development community about the change.
> 
> You might ask "why move them to the wiki?" (or perhaps you just say
> "about time" - in that case ignore the next few paragraphs and jump
> immediately to "what is the result" further down in the mail ;-),
> well let me tell why.
> 
> First of all, the Gentoo Handbooks were the only user-oriented
> documents that the Gentoo Documentation Project "manages" that were
> not on the Gentoo Wiki yet. And although 'back in the days' the
> choice for the XML-based documentation development was valid
> (offline development of documentation was a primary concern) times
> have changed, as well as documentation developer abilities.
> 
> The need to train users into the dark corners of GuideXML (and the
> almost programmatic approach to the Gentoo Handbooks) pushes down
> hard on the team's growth. And that in essence is the second reason
> as well: the Gentoo Documentation Project is no longer the huge
> project it once was. We reduced from over 20 authors/editors to
> only one or two active members - and even those do not do it "full
> time" anymore. Moving towards a better known (and popular)
> documentation platform makes sense.
> 
> Any request to update the handbook (we have a few bugs open on it)
> had to be taken by those few documentation developers, whereas with
> the move to the wiki, I hope that other developers would take up
> the opportunity to update the documentation themselves. Especially
> for the architecture teams who would like to update the Gentoo
> Handbooks with their specific installation instructions will this
> be a blessing (I hope). Also the developers in charge of the
> "additional sections" of the handbook, such as networking, can now 
> help update and maintain the documentation.
> 
> A third reason is that the current website runs an XSLT parser to
> transform the documentation into HTML. The Gentoo Handbook being in
> GuideXML kept on hindering any progress on the website development
> and future as it was a blocker for potential infrastructural
> changes. With the move to the Gentoo Wiki, this is one less concern
> to think about.
> 
> Of course, consolidating all documentation (including the handbook)
> to the wiki provides a common platform for Gentoo's documentation
> development and single writing style. And it gives a universal look
> and feel to the documentation, instead of having two different
> views (GuideXML rendering and Wiki rendering look different), which
> hopefully puts a bit less confusion to the users.
> 
> An advantage is also that the links to the Gentoo Handbook become a
> bit simpler. Consider the link to configuring GRUB2 for AMD64:
> 
> Current handbook: 
> https://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?part=1&chap=10#doc_chap2
>
> 
Wiki handbook:
> https://wiki.gentoo.org/wiki/Handbook:AMD64/Installation/Bootloader#Default:_Using_GRUB2
>
>  Although a tad longer, the link is much more readable, and when
> pasted on things like IRC users can immediately see what it is
> about.
> 
> So, what is the result of this move?
> 
> The various handbooks are available in their own namespace (with
> thanks to Alex Legler for creating it as well as supporting the
> move):
> 
> https://wiki.gentoo.org/wiki/Handbook:Alpha 
> https://wiki.gentoo.org/wiki/Handbook:AMD64 
> https://wiki.gentoo.org/wiki/Handbook:HPPA 
> https://wiki.gentoo.org/wiki/Handbook:IA64 
> https://wiki.gentoo.org/wiki/Handbook:MIPS 
> https://wiki.gentoo.org/wiki/Handbook:PPC 
> https://wiki.gentoo.org/wiki/Handbook:PPC64 
> https://wiki.gentoo.org/wiki/Handbook:SPARC 
> https://wiki.gentoo.org/wiki/Handbook:X86
> 
> If I am not mistaken, these locations should be editable by
> developers and trusted contributors (and if not yet then that is
> the idea to implement).
> 
> All handbooks use the same structure. In effect, there is lots of
> re-use of documentation snippets (as was the case with the Gentoo
> Handbooks in GuideXML). Although I did not implement the same
> "programming-like" documentation development as was done with the
> GuideXML ones, the wikified Gentoo Handbook uses transclusion
> (inclusion of other pages) and Semantic MediaWiki for the dynamic
> generation and changes of documentation.
> 
> Unless people object heavily, I will start updating the GuideXML
> handbooks to redirect the users to the wiki handbooks, as well as
> update the links on the website and wiki articles.
> 
> Note that, when moved, the translations might take some time to
> catch up. This is because the translated information (in GuideXML)
> cannot be easily moved towards the wiki (with the move, texts have
> been updated as well to reflect the wiki writing style), and
> because the wiki uses a translation extension that supports
> parallel translation development - but different than how GuideXML
> translations worked.
> 
> Users interested in the "development" side (what are the reused
> parts and so on) can feed their lusts on 
> https://wiki.gentoo.org/wiki/Project:Documentation/HandbookDevelopment
>
>  I hope this is a start of many updates and improvements. Feedback
> is always welcome of course.
> 
> With kind regards
> 
> Sven Vermeulen aka SwifT
> 

Hello Sven,

thanks for moving the handbooks to the wiki!

Just two things I noticed:
Do you know if it's possible to get the same "full view" as with prior
xml pages?
https://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?full=1

In addition it would be great if we can export full viewed handbooks
as pdf/epub. I guess mediawiki could support that via extensions. Do
you have any plans for that?

Cheers,

Manuel
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0

iQJ8BAEBCgBmBQJUiw1vXxSAAAAAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w
ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXQ4MDA1RERERkM0ODM2QkE4MEY3NzY0N0M1
OEZCQTM2QzhEOUQ2MzVDAAoJEFj7o2yNnWNciQEP/jxbkyXwO6QYogMzSt7+Khxw
fFK74T4O3zf2MnJdHLjjNWXxvokJk3RiZtwNTWw9LMEN9VjuhOY/DugszSg1VKHd
gOz9z1D1nvdvR79x72d4qo1dgEynhpn6ljMffO07g2fdhTd1XtOXdbibWTxnaCEu
U2iY+1fBsZDwWO4zol0o+aoDQKZ+x7dpJZQ9Z0eR1fZbAyI6pqFW1mfLjDc7ra04
dO+vwjW64y4aTdINOlLP4n6YLISEQ62V4ivrrYJO8Jhl+uG4+zfsVz13N/vI1TeH
2SWIx10p3yRHfUBe2wr2Eyx+g5Ub/0+T+CxLG2BnP7q1eIn8dxI/CE2pudzcyBKc
ql+x1I2LyPEpbsoMOCUSXjLfCOtV0LtceQmXo4M7AoDGJvhBJOAGkdZ4Qyj4s9IG
p6psxA99LOZQTG9iY7FpQw6K5WvH8ntD3UyfaGKpB1GvLAM3P8RGZcWHY6pJAIpy
8fGWVig/vGaa92HNxD8XohZ7phZds8WlNzHRNzRtOQNYPW6h3xmvNmC8RcDhFhQI
ciNGvMxcTvRl8nQtUBlAGoyyBisW+YiCuU8Pd4IAJGNvk6BR6QrpVqoweMA0jKtY
Ort+Pa9uyqMDBaXTPGj583Fap2ON3RUNfPrKHjKsjmKRnHp5tRGQUtFp3ULZdV3V
h20yH0ZWGAZZX6C/1AZK
=/K2g
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-12 15:44 ` Manuel Rüger
@ 2014-12-12 17:00   ` Sven Vermeulen
  0 siblings, 0 replies; 28+ messages in thread
From: Sven Vermeulen @ 2014-12-12 17:00 UTC (permalink / raw
  To: gentoo-project

On Fri, Dec 12, 2014 at 04:44:47PM +0100, Manuel Rüger wrote:
> Just two things I noticed:
> Do you know if it's possible to get the same "full view" as with prior
> xml pages?
> https://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?full=1

Possible? Perhaps, but it will not be as functional. With GuideXML we could
"programmatically" update links so that links between pages become a link
within a single page. With the wiki, this is no longer the case.

It is not too difficult to create a single-page "let's include all and
everything" if I can selectively ignore things (like the table of contents
and navigation), which is doable.

I'll think about it.

> In addition it would be great if we can export full viewed handbooks
> as pdf/epub. I guess mediawiki could support that via extensions. Do
> you have any plans for that?

We might focus in a later stage on the PDF/ePub generation like used by
wikibooks. However that needs to be weighted against the downside of
maintaining (and tracking security of) additional extensions in the wiki.

So yes, we might go towards that. But there are no exact plans on that yet.

Wkr,
	Sven Vermeulen


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-12 15:30 [gentoo-project] Gentoo Handbooks moving to the wiki Sven Vermeulen
  2014-12-12 15:44 ` Manuel Rüger
@ 2014-12-13 13:05 ` Alexander Berntsen
  2014-12-13 14:55   ` Ulrich Mueller
  2014-12-14 13:57   ` Ben de Groot
  2014-12-20 21:40 ` Tom Wijsman
  2 siblings, 2 replies; 28+ messages in thread
From: Alexander Berntsen @ 2014-12-13 13:05 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

I had a quick look and did not immediately see a way to choose between
seeing one chapter per page or the entire handbook in one page.

If this is not presently possible, please bring back the old handbook
until it will be possible.

The wiki is not nice to use in elinks or lynx with one small section
at the time. Nor is it useful to make a printed version. I want a
hand*book*, not a handwiki.
- -- 
Alexander
bernalex@gentoo.org
https://secure.plaimi.net/~alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iF4EAREIAAYFAlSMOZAACgkQRtClrXBQc7Ut9gD7B+L/Ckyzgp/zXCHQpGYFzjAg
UoyhziYr/tAUyzI+BFgA/06wgDUwk87sA3N5o/d64+AVhnKMAmMBF/z5MTOru2F0
=kVtN
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 13:05 ` Alexander Berntsen
@ 2014-12-13 14:55   ` Ulrich Mueller
  2014-12-13 15:40     ` Sven Vermeulen
  2014-12-14 13:57   ` Ben de Groot
  1 sibling, 1 reply; 28+ messages in thread
From: Ulrich Mueller @ 2014-12-13 14:55 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 518 bytes --]

>>>>> On Sat, 13 Dec 2014, Alexander Berntsen wrote:

> The wiki is not nice to use in elinks or lynx with one small section
> at the time. Nor is it useful to make a printed version. I want a
> hand*book*, not a handwiki.

I see that Wikipedia has some tool for creating books from collections
of articles, maybe that could be used for creating a printed version?

http://en.wikipedia.org/wiki/Help:Books
https://www.mediawiki.org/wiki/Extension:Collection
https://www.mediawiki.org/wiki/Extension:PDF_Writer

Ulrich

[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 14:55   ` Ulrich Mueller
@ 2014-12-13 15:40     ` Sven Vermeulen
  2014-12-13 15:41       ` Alexander Berntsen
                         ` (2 more replies)
  0 siblings, 3 replies; 28+ messages in thread
From: Sven Vermeulen @ 2014-12-13 15:40 UTC (permalink / raw
  To: gentoo-project

On Sat, Dec 13, 2014 at 03:55:30PM +0100, Ulrich Mueller wrote:
> >>>>> On Sat, 13 Dec 2014, Alexander Berntsen wrote:
> > The wiki is not nice to use in elinks or lynx with one small section
> > at the time. Nor is it useful to make a printed version. I want a
> > hand*book*, not a handwiki.
> 
> I see that Wikipedia has some tool for creating books from collections
> of articles, maybe that could be used for creating a printed version?
> 
> http://en.wikipedia.org/wiki/Help:Books
> https://www.mediawiki.org/wiki/Extension:Collection
> https://www.mediawiki.org/wiki/Extension:PDF_Writer

As mentioned before, yes there are ways to accomplish that. But as
mentioned, these extensions can't just be enabled and hoping for the best.
They'll need to be maintained, the resources on the server(s) need to be
available for the dynamic generation of books and perhaps some other things
that I am missing (I haven't managed a mediawiki server yet so I can't speak
from much experience).

However, I do capture the need for an "all-on-one-page" and will look into
that first. It will not have working links for in-book navigation though but
it might already be enough for users who want everything on one page (esp.
those who want to print them out).

Thanks for the feedback!

Wkr,
	Sven Vermeulen


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 15:40     ` Sven Vermeulen
@ 2014-12-13 15:41       ` Alexander Berntsen
  2014-12-13 15:53       ` Rich Freeman
  2014-12-13 19:47       ` Sven Vermeulen
  2 siblings, 0 replies; 28+ messages in thread
From: Alexander Berntsen @ 2014-12-13 15:41 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 13/12/14 16:40, Sven Vermeulen wrote:
> Thanks for the feedback!
Thanks for all the work you have put in.

- -- 
Alexander
bernalex@gentoo.org
https://secure.plaimi.net/~alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iF4EAREIAAYFAlSMXiMACgkQRtClrXBQc7VSzgD9FDIVUAyAfi9Yz0MdTCmg25W5
ZX9wbgVB//G7CroY/OcBALDjdVLTxDK3BsChYNaWeq39RAXDOTRP1Zuo4niIhbVg
=qRDM
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 15:40     ` Sven Vermeulen
  2014-12-13 15:41       ` Alexander Berntsen
@ 2014-12-13 15:53       ` Rich Freeman
  2014-12-13 16:02         ` Alexander Berntsen
  2014-12-13 19:47       ` Sven Vermeulen
  2 siblings, 1 reply; 28+ messages in thread
From: Rich Freeman @ 2014-12-13 15:53 UTC (permalink / raw
  To: gentoo-project

On Sat, Dec 13, 2014 at 10:40 AM, Sven Vermeulen <swift@gentoo.org> wrote:
>
> However, I do capture the need for an "all-on-one-page" and will look into
> that first.

s/need/want

I think it is more important to migrate the handbook than to make it
work like a book.  As you pointed out it is not as well-maintained
today and if it were on the wiki there are many more who would be able
to contribute to it.

If there are some who really want to see it work like a book I'd
suggest that they take the lead on making this happen.

Yes, I realize that this is a temporary regression, but so is not
having anybody on the docs team working on the current handbook.


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 15:53       ` Rich Freeman
@ 2014-12-13 16:02         ` Alexander Berntsen
  2014-12-13 16:27           ` Ciaran McCreesh
  0 siblings, 1 reply; 28+ messages in thread
From: Alexander Berntsen @ 2014-12-13 16:02 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 13/12/14 16:53, Rich Freeman wrote:
> On Sat, Dec 13, 2014 at 10:40 AM, Sven Vermeulen <swift@gentoo.org>
>  wrote:
>> However, I do capture the need for an "all-on-one-page" and will
>>  look into that first.
> s/need/want
Pointless distinction.

Please do not make the old handbook website inaccessible until this is
in place.
- -- 
Alexander
bernalex@gentoo.org
https://secure.plaimi.net/~alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iF4EAREIAAYFAlSMYzEACgkQRtClrXBQc7U2dAD/RMSS0aaE2tAuJNddRDhDVryO
y4k2akMyBZsfmvJT6V0A/3MEbRYdYJPQqDC14M2t6yer/BlcSjC8yUGtFVe2SY0h
=NWao
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 16:02         ` Alexander Berntsen
@ 2014-12-13 16:27           ` Ciaran McCreesh
  2014-12-13 16:34             ` Alexander Berntsen
  2014-12-13 18:35             ` Andreas K. Huettel
  0 siblings, 2 replies; 28+ messages in thread
From: Ciaran McCreesh @ 2014-12-13 16:27 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 518 bytes --]

On Sat, 13 Dec 2014 17:02:57 +0100
Alexander Berntsen <bernalex@gentoo.org> wrote:
> On 13/12/14 16:53, Rich Freeman wrote:
> > On Sat, Dec 13, 2014 at 10:40 AM, Sven Vermeulen <swift@gentoo.org>
> >  wrote:
> >> However, I do capture the need for an "all-on-one-page" and will
> >>  look into that first.
> > s/need/want
>
> Pointless distinction.

It's really not. Refusal to make changes that remove an obscure piece
of functionality is one of the reasons Gentoo has stagnated.

-- 
Ciaran McCreesh

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 16:27           ` Ciaran McCreesh
@ 2014-12-13 16:34             ` Alexander Berntsen
  2014-12-13 17:03               ` Rich Freeman
  2014-12-13 18:35             ` Andreas K. Huettel
  1 sibling, 1 reply; 28+ messages in thread
From: Alexander Berntsen @ 2014-12-13 16:34 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 13/12/14 17:27, Ciaran McCreesh wrote:
> On Sat, 13 Dec 2014 17:02:57 +0100 Alexander Berntsen 
> <bernalex@gentoo.org> wrote:
>> On 13/12/14 16:53, Rich Freeman wrote:
>>> s/need/want
>> Pointless distinction.
> It's really not. Refusal to make changes that remove an obscure 
> piece of functionality is one of the reasons Gentoo has stagnated.
It is a subjective sensation whether you are feeling a "need" or
merely a "want". "need" vs. "want" becomes a pointless exercise in
semantics bikeshedding if I can just redefine your "needs" as "wants",
simply because I do not care about them,
- -- 
Alexander
bernalex@gentoo.org
https://secure.plaimi.net/~alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iF4EAREIAAYFAlSMao0ACgkQRtClrXBQc7XRAAD+LwNz5f0u0Mh2N4FIP6Zmm0eM
EzeIVEMLBp9aYgZ3GYIBAISknh4U16SCjGomfGwStQmTdBkpQrrAi6KVUNwZUSty
=y0eN
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 16:34             ` Alexander Berntsen
@ 2014-12-13 17:03               ` Rich Freeman
  0 siblings, 0 replies; 28+ messages in thread
From: Rich Freeman @ 2014-12-13 17:03 UTC (permalink / raw
  To: gentoo-project

On Sat, Dec 13, 2014 at 11:34 AM, Alexander Berntsen
<bernalex@gentoo.org> wrote:
> On 13/12/14 17:27, Ciaran McCreesh wrote:
>> On Sat, 13 Dec 2014 17:02:57 +0100 Alexander Berntsen
>> <bernalex@gentoo.org> wrote:
>>> On 13/12/14 16:53, Rich Freeman wrote:
>>>> s/need/want
>>> Pointless distinction.
>> It's really not. Refusal to make changes that remove an obscure
>> piece of functionality is one of the reasons Gentoo has stagnated.
> It is a subjective sensation whether you are feeling a "need" or
> merely a "want". "need" vs. "want" becomes a pointless exercise in
> semantics bikeshedding if I can just redefine your "needs" as "wants",
> simply because I do not care about them,

I think the most practical definition of "need" is that it means that
you step up to do the work.

I don't mean to pick on you, but Ciaran has a point.  There are many
examples of cases in Gentoo where people don't want to step up and fix
things, because they're expected to maintain every corner-case
somebody bothered to add over the years when they do so.  They have an
itch to scratch, but they'd just as soon fork the thing instead of try
to fix it.  And on that note, for a bonus challenge go ahead and see
how many alternate Gentoo install handbooks you can find floating
around.

--
Rich


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 16:27           ` Ciaran McCreesh
  2014-12-13 16:34             ` Alexander Berntsen
@ 2014-12-13 18:35             ` Andreas K. Huettel
  2014-12-14 13:11               ` Markos Chandras
  1 sibling, 1 reply; 28+ messages in thread
From: Andreas K. Huettel @ 2014-12-13 18:35 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: Text/Plain, Size: 811 bytes --]

Am Samstag, 13. Dezember 2014, 17:27:40 schrieb Ciaran McCreesh:
> On Sat, 13 Dec 2014 17:02:57 +0100
> 
> Alexander Berntsen <bernalex@gentoo.org> wrote:
> > On 13/12/14 16:53, Rich Freeman wrote:
> > > On Sat, Dec 13, 2014 at 10:40 AM, Sven Vermeulen <swift@gentoo.org>
> > > 
> > >  wrote:
> > >> However, I do capture the need for an "all-on-one-page" and will
> > >> 
> > >>  look into that first.
> > > 
> > > s/need/want
> > 
> > Pointless distinction.
> 
> It's really not. Refusal to make changes that remove an obscure piece
> of functionality is one of the reasons Gentoo has stagnated.

++

(Just think of the git migration.)

(Cheers! / Prost! / На здоровье!)

-- 

Andreas K. Huettel
Gentoo Linux developer 
dilfridge@gentoo.org
http://www.akhuettel.de/


[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 951 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 15:40     ` Sven Vermeulen
  2014-12-13 15:41       ` Alexander Berntsen
  2014-12-13 15:53       ` Rich Freeman
@ 2014-12-13 19:47       ` Sven Vermeulen
  2 siblings, 0 replies; 28+ messages in thread
From: Sven Vermeulen @ 2014-12-13 19:47 UTC (permalink / raw
  To: gentoo-project

On Sat, Dec 13, 2014 at 03:40:35PM +0000, Sven Vermeulen wrote:
> However, I do capture the need for an "all-on-one-page" and will look into
> that first. It will not have working links for in-book navigation though but
> it might already be enough for users who want everything on one page (esp.
> those who want to print them out).

I've been able to create all-in-one pages for each separate part. The links
are available on https://wiki.gentoo.org/wiki/Handbook:Main_Page

I was not able to create a single one-page for the entire handbook (in other
words, it is one page for "Installing Gentoo Linux", one page for "Working
with Gentoo", etc.) due to restrictions in MediaWiki - I can imagine that
the multi-transclusion approach that we need for generating
architecture-specific handbooks takes up quite some resources on the
generation.

Hopefully this at least covers the most cases of users who want a
single-page view on the installation instructions (which I believe is the
most common one).

Wkr,
	Sven Vermeulen


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 18:35             ` Andreas K. Huettel
@ 2014-12-14 13:11               ` Markos Chandras
  0 siblings, 0 replies; 28+ messages in thread
From: Markos Chandras @ 2014-12-14 13:11 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

On 12/13/2014 06:35 PM, Andreas K. Huettel wrote:
> Am Samstag, 13. Dezember 2014, 17:27:40 schrieb Ciaran McCreesh:
>> On Sat, 13 Dec 2014 17:02:57 +0100
>> 
>> Alexander Berntsen <bernalex@gentoo.org> wrote:
>>> On 13/12/14 16:53, Rich Freeman wrote:
>>>> On Sat, Dec 13, 2014 at 10:40 AM, Sven Vermeulen
>>>> <swift@gentoo.org>
>>>> 
>>>> wrote:
>>>>> However, I do capture the need for an "all-on-one-page" and
>>>>> will
>>>>> 
>>>>> look into that first.
>>>> 
>>>> s/need/want
>>> 
>>> Pointless distinction.
>> 
>> It's really not. Refusal to make changes that remove an obscure
>> piece of functionality is one of the reasons Gentoo has
>> stagnated.
> 
> ++
> 
> (Just think of the git migration.)
> 
> (Cheers! / Prost! / На здоровье!)
> 
oh noes... let's not turn this thread into another "git migration"
topic. can we stay on-topic please?

https://imgflip.com/i/fauzy

- -- 
Regards,
Markos Chandras
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQF8BAEBCgBmBQJUjYyHXxSAAAAAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w
ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXRGRDlGMzA4MUI2MzBDODQ4RDBGOEYxMjQx
RjEwRUQ0QjgxREVCRjE5AAoJEB8Q7UuB3r8ZfbEIAKKUK8NSjbLQGBt3PYzFz5tv
B0HGjXbvCVJ9lmHEb1tLgwEQiDtZZwIaaaUM19n8QqSoXacnPWWDeHpVWTU7sFAG
7qBqVx9tRFZ/mp6XJq/t6JinAUE9RZQ2VS2xKI2dP4/g5296fSVN4I1uxjd4H7PU
Q/p2UKrGlUjR6ejesCAOuXcIrD8BaZ82W4acZC1FRJOmxVp8EYan2oMKxTjQd6Iy
DE+DdZ7lmsJHvcS2T9lhpA8jlmovHsH1ZjOuYxw0KPPS9JxRFR9f1grbKtR6lypD
qkqvx5IT6TM58zC3e820U1IYl88viCmZ6V1hlibb82j5SkgjzvYYJazqKyFC1nk=
=zL1n
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-13 13:05 ` Alexander Berntsen
  2014-12-13 14:55   ` Ulrich Mueller
@ 2014-12-14 13:57   ` Ben de Groot
  2014-12-14 13:59     ` Alexander Berntsen
  1 sibling, 1 reply; 28+ messages in thread
From: Ben de Groot @ 2014-12-14 13:57 UTC (permalink / raw
  To: gentoo-project

On 13 December 2014 at 21:05, Alexander Berntsen <bernalex@gentoo.org> wrote:
> I had a quick look and did not immediately see a way to choose between
> seeing one chapter per page or the entire handbook in one page.

Is https://wiki.gentoo.org/wiki/Quick_install_guide not enough for your needs?
-- 
Cheers,

Ben | yngwin
Gentoo developer


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 13:57   ` Ben de Groot
@ 2014-12-14 13:59     ` Alexander Berntsen
  2014-12-14 14:04       ` Ben de Groot
  0 siblings, 1 reply; 28+ messages in thread
From: Alexander Berntsen @ 2014-12-14 13:59 UTC (permalink / raw
  To: gentoo-project

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 14/12/14 14:57, Ben de Groot wrote:
> Is https://wiki.gentoo.org/wiki/Quick_install_guide not enough for 
> your needs?
No.

I like having a comprehensive book to lend friends and look at when
helping friends install Gentoo. This is not comprehensive enough for a
newbie.
- -- 
Alexander
bernalex@gentoo.org
https://secure.plaimi.net/~alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iF4EAREIAAYFAlSNl7kACgkQRtClrXBQc7W5cAD8CfbOdIBETfOmxPQGc9LBzoHQ
qsXLg+0b4FKM8F/EsWABAK8uKEcKlhsV2I5Mg6tWoCfrF4Ycorr2KQEi4TNCoYEn
=6Bih
-----END PGP SIGNATURE-----


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 13:59     ` Alexander Berntsen
@ 2014-12-14 14:04       ` Ben de Groot
  2014-12-14 14:22         ` Andrew Savchenko
  0 siblings, 1 reply; 28+ messages in thread
From: Ben de Groot @ 2014-12-14 14:04 UTC (permalink / raw
  To: gentoo-project

On 14 December 2014 at 21:59, Alexander Berntsen <bernalex@gentoo.org> wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA256
>
> On 14/12/14 14:57, Ben de Groot wrote:
>> Is https://wiki.gentoo.org/wiki/Quick_install_guide not enough for
>> your needs?
> No.
>
> I like having a comprehensive book to lend friends and look at when
> helping friends install Gentoo. This is not comprehensive enough for a
> newbie.

In such cases I would recommend a Live USB (or CD/DVD) that has a
graphical environment, so that the user can keep a modern web browser
next to a terminal window, to ease installation. In that case the wiki
is perfectly usable.

-- 
Cheers,

Ben | yngwin
Gentoo developer


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 14:04       ` Ben de Groot
@ 2014-12-14 14:22         ` Andrew Savchenko
  2014-12-14 14:45           ` Matthias Maier
  2014-12-14 15:02           ` Jeff Horelick
  0 siblings, 2 replies; 28+ messages in thread
From: Andrew Savchenko @ 2014-12-14 14:22 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 1728 bytes --]

Hi,

On Sun, 14 Dec 2014 22:04:28 +0800 Ben de Groot wrote:
> On 14 December 2014 at 21:59, Alexander Berntsen <bernalex@gentoo.org> wrote:
> > -----BEGIN PGP SIGNED MESSAGE-----
> > Hash: SHA256
> >
> > On 14/12/14 14:57, Ben de Groot wrote:
> >> Is https://wiki.gentoo.org/wiki/Quick_install_guide not enough for
> >> your needs?
> > No.
> >
> > I like having a comprehensive book to lend friends and look at when
> > helping friends install Gentoo. This is not comprehensive enough for a
> > newbie.
> 
> In such cases I would recommend a Live USB (or CD/DVD) that has a
> graphical environment, so that the user can keep a modern web browser
> next to a terminal window, to ease installation. In that case the wiki
> is perfectly usable.

No, this is not a solution, because on particular hardware live
media (live usb/cd/dvd/whatever) may fail with video or gui support.

I had such problem this year, when I had to install Gentoo from
LiveCD without ability to use any other host for support (reading
howtos, googling and so on). I used SystemRescueCD because of ample
set of debug, admin and analysis tools I needed to configure
system properly, but GUI was just a failure due to lack of nvidia
drivers out of the box. Of course, I can easily fix such issues
when fresh system is installed, but while it was being installed I
had to use what is available from the live media. And elinks was a
great help back there.

So it will be really nice to keep handbook copies outside of wiki
interface. Probably a reasonable compromise will be to keep
handbooks at the wiki, but to use some script to generate simpler
htmls for out of the wiki usage scope.

Best regards,
Andrew Savchenko

[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 14:22         ` Andrew Savchenko
@ 2014-12-14 14:45           ` Matthias Maier
  2014-12-14 15:18             ` Rich Freeman
  2014-12-14 15:02           ` Jeff Horelick
  1 sibling, 1 reply; 28+ messages in thread
From: Matthias Maier @ 2014-12-14 14:45 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 307 bytes --]


This discussion is getting absurd.

Centralizing the documentation (i.e. moving to the wiki in this place)
makes a lot of sense. If we loose some of the former layouts for a
moment, then that's the way it is.


And again, thanks for all the hard work that was put into the
documentation!

Best,
Matthias



[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 820 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 14:22         ` Andrew Savchenko
  2014-12-14 14:45           ` Matthias Maier
@ 2014-12-14 15:02           ` Jeff Horelick
  2014-12-14 15:19             ` Andrew Savchenko
  2014-12-15 11:25             ` Ben de Groot
  1 sibling, 2 replies; 28+ messages in thread
From: Jeff Horelick @ 2014-12-14 15:02 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 2345 bytes --]

On 14 December 2014 at 09:22, Andrew Savchenko <bircoph@gentoo.org> wrote:

> Hi,
>
> On Sun, 14 Dec 2014 22:04:28 +0800 Ben de Groot wrote:
> > On 14 December 2014 at 21:59, Alexander Berntsen <bernalex@gentoo.org>
> wrote:
> > > -----BEGIN PGP SIGNED MESSAGE-----
> > > Hash: SHA256
> > >
> > > On 14/12/14 14:57, Ben de Groot wrote:
> > >> Is https://wiki.gentoo.org/wiki/Quick_install_guide not enough for
> > >> your needs?
> > > No.
> > >
> > > I like having a comprehensive book to lend friends and look at when
> > > helping friends install Gentoo. This is not comprehensive enough for a
> > > newbie.
> >
> > In such cases I would recommend a Live USB (or CD/DVD) that has a
> > graphical environment, so that the user can keep a modern web browser
> > next to a terminal window, to ease installation. In that case the wiki
> > is perfectly usable.
>
> No, this is not a solution, because on particular hardware live
> media (live usb/cd/dvd/whatever) may fail with video or gui support.
>
> I had such problem this year, when I had to install Gentoo from
> LiveCD without ability to use any other host for support (reading
> howtos, googling and so on). I used SystemRescueCD because of ample
> set of debug, admin and analysis tools I needed to configure
> system properly, but GUI was just a failure due to lack of nvidia
> drivers out of the box. Of course, I can easily fix such issues
> when fresh system is installed, but while it was being installed I
> had to use what is available from the live media. And elinks was a
> great help back there.
>
> So it will be really nice to keep handbook copies outside of wiki
> interface. Probably a reasonable compromise will be to keep
> handbooks at the wiki, but to use some script to generate simpler
> htmls for out of the wiki usage scope.
>
> Best regards,
> Andrew Savchenko
>


I feel like we do not need to optimize for this case really. I feel that
the odds of installing Gentoo where you have no GUI (via either the LiveDVD
or SystemRescueCD), no smartphone to use to look at the wiki, no tablet to
use to look at the wiki (I'm not sure about elsewhere, but here in the US,
you can get a brand-new Android tablet for $40 USD at a physical store
(less online) and in the UK you can find them under 50GBP), no spare
computers to use to look at the wiki are extremely unlikely.

[-- Attachment #2: Type: text/html, Size: 3037 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 14:45           ` Matthias Maier
@ 2014-12-14 15:18             ` Rich Freeman
  0 siblings, 0 replies; 28+ messages in thread
From: Rich Freeman @ 2014-12-14 15:18 UTC (permalink / raw
  To: gentoo-project

On Sun, Dec 14, 2014 at 9:45 AM, Matthias Maier <tamiko@gentoo.org> wrote:
>
> This discussion is getting absurd.
>
> Centralizing the documentation (i.e. moving to the wiki in this place)
> makes a lot of sense. If we loose some of the former layouts for a
> moment, then that's the way it is.
>

++

If necessary it could be stuck on the council agenda, but I'd be
shocked if the vote wasn't 7-0 to let it move it to the wiki with
whatever compromises are necessary to make it happen (this isn't
nearly as controversial as dropping changelogs when we move to git).
I'd suggest just moving forward - if anybody wants to force a council
vote they can stick it on the next agenda.

I'm all for having versions of the handbook available in any format
that people are willing to provide, including a hardcover tabletop
edition with glossy pages and a bronze Larry the Cow on the cover.  I
just think that the onus is on those who want such things to provide
them.


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 15:02           ` Jeff Horelick
@ 2014-12-14 15:19             ` Andrew Savchenko
  2014-12-14 19:46               ` malc
  2014-12-15 11:25             ` Ben de Groot
  1 sibling, 1 reply; 28+ messages in thread
From: Andrew Savchenko @ 2014-12-14 15:19 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 2604 bytes --]

On Sun, 14 Dec 2014 10:02:36 -0500 Jeff Horelick wrote:
> > > In such cases I would recommend a Live USB (or CD/DVD) that has a
> > > graphical environment, so that the user can keep a modern web browser
> > > next to a terminal window, to ease installation. In that case the wiki
> > > is perfectly usable.
> >
> > No, this is not a solution, because on particular hardware live
> > media (live usb/cd/dvd/whatever) may fail with video or gui support.
> >
> > I had such problem this year, when I had to install Gentoo from
> > LiveCD without ability to use any other host for support (reading
> > howtos, googling and so on). I used SystemRescueCD because of ample
> > set of debug, admin and analysis tools I needed to configure
> > system properly, but GUI was just a failure due to lack of nvidia
> > drivers out of the box. Of course, I can easily fix such issues
> > when fresh system is installed, but while it was being installed I
> > had to use what is available from the live media. And elinks was a
> > great help back there.
> >
> > So it will be really nice to keep handbook copies outside of wiki
> > interface. Probably a reasonable compromise will be to keep
> > handbooks at the wiki, but to use some script to generate simpler
> > htmls for out of the wiki usage scope.
> >
> > Best regards,
> > Andrew Savchenko
> >
> 
> 
> I feel like we do not need to optimize for this case really. I feel that
> the odds of installing Gentoo where you have no GUI (via either the LiveDVD
> or SystemRescueCD), no smartphone to use to look at the wiki, no tablet to
> use to look at the wiki (I'm not sure about elsewhere, but here in the US,
> you can get a brand-new Android tablet for $40 USD at a physical store
> (less online) and in the UK you can find them under 50GBP), no spare
> computers to use to look at the wiki are extremely unlikely.

This case was really simple: use of any electronic devices aside
from PC in question was prohibited due to company's security
policies. In fact this is quite common case when we're talking
about business setups and not private workstations.

Also I'd like to note that smartphone is not solution for people
without perfect eyesight (e.g. me): reading too much text from small
screen is either painful (with small fonts) or inconvenient (with
large ones).

Please note I'm not saying "do not put handbooks in wiki" — this
is really a good idea to have all docs in one place; I'm talking
about some backup solution for such cases, like simple generated
htmls.

Best regards,
Andrew Savchenko

[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 15:19             ` Andrew Savchenko
@ 2014-12-14 19:46               ` malc
  2014-12-14 20:31                 ` Andrew Savchenko
  0 siblings, 1 reply; 28+ messages in thread
From: malc @ 2014-12-14 19:46 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 3442 bytes --]

What about simple transclusion? [1] Example of first few handbook-chapters
at [2]
It's not pretty (the top TOC works, but the inline-toc on the
right-hand-side doesn't work) That could be prevented with some <noinclude>
directives on the source pages but I didn't want to trample over Sven.
Would that work? (And yes - a few other includes are broken because this is
rooted in my user-space and not under the handbook, but I think these
should work if a page of this type was included in the Handbook namespace.)

Cheers,
malc.

[1] http://www.mediawiki.org/wiki/Transclusion
[2] https://wiki.gentoo.org/wiki/User:Mlashley

On Sun, Dec 14, 2014 at 3:19 PM, Andrew Savchenko <bircoph@gentoo.org>
wrote:

> On Sun, 14 Dec 2014 10:02:36 -0500 Jeff Horelick wrote:
> > > > In such cases I would recommend a Live USB (or CD/DVD) that has a
> > > > graphical environment, so that the user can keep a modern web browser
> > > > next to a terminal window, to ease installation. In that case the
> wiki
> > > > is perfectly usable.
> > >
> > > No, this is not a solution, because on particular hardware live
> > > media (live usb/cd/dvd/whatever) may fail with video or gui support.
> > >
> > > I had such problem this year, when I had to install Gentoo from
> > > LiveCD without ability to use any other host for support (reading
> > > howtos, googling and so on). I used SystemRescueCD because of ample
> > > set of debug, admin and analysis tools I needed to configure
> > > system properly, but GUI was just a failure due to lack of nvidia
> > > drivers out of the box. Of course, I can easily fix such issues
> > > when fresh system is installed, but while it was being installed I
> > > had to use what is available from the live media. And elinks was a
> > > great help back there.
> > >
> > > So it will be really nice to keep handbook copies outside of wiki
> > > interface. Probably a reasonable compromise will be to keep
> > > handbooks at the wiki, but to use some script to generate simpler
> > > htmls for out of the wiki usage scope.
> > >
> > > Best regards,
> > > Andrew Savchenko
> > >
> >
> >
> > I feel like we do not need to optimize for this case really. I feel that
> > the odds of installing Gentoo where you have no GUI (via either the
> LiveDVD
> > or SystemRescueCD), no smartphone to use to look at the wiki, no tablet
> to
> > use to look at the wiki (I'm not sure about elsewhere, but here in the
> US,
> > you can get a brand-new Android tablet for $40 USD at a physical store
> > (less online) and in the UK you can find them under 50GBP), no spare
> > computers to use to look at the wiki are extremely unlikely.
>
> This case was really simple: use of any electronic devices aside
> from PC in question was prohibited due to company's security
> policies. In fact this is quite common case when we're talking
> about business setups and not private workstations.
>
> Also I'd like to note that smartphone is not solution for people
> without perfect eyesight (e.g. me): reading too much text from small
> screen is either painful (with small fonts) or inconvenient (with
> large ones).
>
> Please note I'm not saying "do not put handbooks in wiki" — this
> is really a good idea to have all docs in one place; I'm talking
> about some backup solution for such cases, like simple generated
> htmls.
>
> Best regards,
> Andrew Savchenko
>

[-- Attachment #2: Type: text/html, Size: 4319 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 19:46               ` malc
@ 2014-12-14 20:31                 ` Andrew Savchenko
  2014-12-15  8:11                   ` Sven Vermeulen
  0 siblings, 1 reply; 28+ messages in thread
From: Andrew Savchenko @ 2014-12-14 20:31 UTC (permalink / raw
  To: gentoo-project

[-- Attachment #1: Type: text/plain, Size: 3837 bytes --]

On Sun, 14 Dec 2014 19:46:27 +0000 malc wrote:
> What about simple transclusion? [1] Example of first few handbook-chapters
> at [2]

Looks quite readable in elinks.

> It's not pretty (the top TOC works, but the inline-toc on the
> right-hand-side doesn't work) That could be prevented with some <noinclude>
> directives on the source pages but I didn't want to trample over Sven.
> Would that work? (And yes - a few other includes are broken because this is
> rooted in my user-space and not under the handbook, but I think these
> should work if a page of this type was included in the Handbook namespace.)

Well, it doesn't have to be perfect, it should be usable enough.
Looks like transclusion solves usability problem :)

> Cheers,
> malc.
> 
> [1] http://www.mediawiki.org/wiki/Transclusion
> [2] https://wiki.gentoo.org/wiki/User:Mlashley
> 
> On Sun, Dec 14, 2014 at 3:19 PM, Andrew Savchenko <bircoph@gentoo.org>
> wrote:
> 
> > On Sun, 14 Dec 2014 10:02:36 -0500 Jeff Horelick wrote:
> > > > > In such cases I would recommend a Live USB (or CD/DVD) that has a
> > > > > graphical environment, so that the user can keep a modern web browser
> > > > > next to a terminal window, to ease installation. In that case the
> > wiki
> > > > > is perfectly usable.
> > > >
> > > > No, this is not a solution, because on particular hardware live
> > > > media (live usb/cd/dvd/whatever) may fail with video or gui support.
> > > >
> > > > I had such problem this year, when I had to install Gentoo from
> > > > LiveCD without ability to use any other host for support (reading
> > > > howtos, googling and so on). I used SystemRescueCD because of ample
> > > > set of debug, admin and analysis tools I needed to configure
> > > > system properly, but GUI was just a failure due to lack of nvidia
> > > > drivers out of the box. Of course, I can easily fix such issues
> > > > when fresh system is installed, but while it was being installed I
> > > > had to use what is available from the live media. And elinks was a
> > > > great help back there.
> > > >
> > > > So it will be really nice to keep handbook copies outside of wiki
> > > > interface. Probably a reasonable compromise will be to keep
> > > > handbooks at the wiki, but to use some script to generate simpler
> > > > htmls for out of the wiki usage scope.
> > > >
> > > > Best regards,
> > > > Andrew Savchenko
> > > >
> > >
> > >
> > > I feel like we do not need to optimize for this case really. I feel that
> > > the odds of installing Gentoo where you have no GUI (via either the
> > LiveDVD
> > > or SystemRescueCD), no smartphone to use to look at the wiki, no tablet
> > to
> > > use to look at the wiki (I'm not sure about elsewhere, but here in the
> > US,
> > > you can get a brand-new Android tablet for $40 USD at a physical store
> > > (less online) and in the UK you can find them under 50GBP), no spare
> > > computers to use to look at the wiki are extremely unlikely.
> >
> > This case was really simple: use of any electronic devices aside
> > from PC in question was prohibited due to company's security
> > policies. In fact this is quite common case when we're talking
> > about business setups and not private workstations.
> >
> > Also I'd like to note that smartphone is not solution for people
> > without perfect eyesight (e.g. me): reading too much text from small
> > screen is either painful (with small fonts) or inconvenient (with
> > large ones).
> >
> > Please note I'm not saying "do not put handbooks in wiki" — this
> > is really a good idea to have all docs in one place; I'm talking
> > about some backup solution for such cases, like simple generated
> > htmls.
> >
> > Best regards,
> > Andrew Savchenko
> >


Best regards,
Andrew Savchenko

[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 20:31                 ` Andrew Savchenko
@ 2014-12-15  8:11                   ` Sven Vermeulen
  0 siblings, 0 replies; 28+ messages in thread
From: Sven Vermeulen @ 2014-12-15  8:11 UTC (permalink / raw
  To: gentoo-project

On Sun, Dec 14, 2014 at 11:31:07PM +0300, Andrew Savchenko wrote:
> On Sun, 14 Dec 2014 19:46:27 +0000 malc wrote:
> > What about simple transclusion? [1] Example of first few handbook-chapters
> > at [2]
> 
> Looks quite readable in elinks.
> 
> > It's not pretty (the top TOC works, but the inline-toc on the
> > right-hand-side doesn't work) That could be prevented with some <noinclude>
> > directives on the source pages but I didn't want to trample over Sven.
> > Would that work? (And yes - a few other includes are broken because this is
> > rooted in my user-space and not under the handbook, but I think these
> > should work if a page of this type was included in the Handbook namespace.)
> 
> Well, it doesn't have to be perfect, it should be usable enough.
> Looks like transclusion solves usability problem :)

I'm not sure why the discussion is still ongoing. The full-page handbooks
have been implemented on the wiki a few days ago already (see my message to
gentoo-project [1]). The redirects on the old handbooks have been put in
place to the wiki ones.

[1] http://thread.gmane.org/gmane.linux.gentoo.project/4141

Wkr,
	Sven Vermeulen


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-14 15:02           ` Jeff Horelick
  2014-12-14 15:19             ` Andrew Savchenko
@ 2014-12-15 11:25             ` Ben de Groot
  1 sibling, 0 replies; 28+ messages in thread
From: Ben de Groot @ 2014-12-15 11:25 UTC (permalink / raw
  To: gentoo-project

On 14 December 2014 at 23:02, Jeff Horelick <jdhore@gentoo.org> wrote:
> On 14 December 2014 at 09:22, Andrew Savchenko <bircoph@gentoo.org> wrote:
>>
>> Hi,
>>
>> On Sun, 14 Dec 2014 22:04:28 +0800 Ben de Groot wrote:
>> > On 14 December 2014 at 21:59, Alexander Berntsen <bernalex@gentoo.org>
>> > wrote:
>> > > -----BEGIN PGP SIGNED MESSAGE-----
>> > > Hash: SHA256
>> > >
>> > > On 14/12/14 14:57, Ben de Groot wrote:
>> > >> Is https://wiki.gentoo.org/wiki/Quick_install_guide not enough for
>> > >> your needs?
>> > > No.
>> > >
>> > > I like having a comprehensive book to lend friends and look at when
>> > > helping friends install Gentoo. This is not comprehensive enough for a
>> > > newbie.
>> >
>> > In such cases I would recommend a Live USB (or CD/DVD) that has a
>> > graphical environment, so that the user can keep a modern web browser
>> > next to a terminal window, to ease installation. In that case the wiki
>> > is perfectly usable.
>>
>> No, this is not a solution, because on particular hardware live
>> media (live usb/cd/dvd/whatever) may fail with video or gui support.
>>
>> I had such problem this year, when I had to install Gentoo from
>> LiveCD without ability to use any other host for support (reading
>> howtos, googling and so on). I used SystemRescueCD because of ample
>> set of debug, admin and analysis tools I needed to configure
>> system properly, but GUI was just a failure due to lack of nvidia
>> drivers out of the box. Of course, I can easily fix such issues
>> when fresh system is installed, but while it was being installed I
>> had to use what is available from the live media. And elinks was a
>> great help back there.
>>
>> So it will be really nice to keep handbook copies outside of wiki
>> interface. Probably a reasonable compromise will be to keep
>> handbooks at the wiki, but to use some script to generate simpler
>> htmls for out of the wiki usage scope.
>>
>> Best regards,
>> Andrew Savchenko
>
>
>
> I feel like we do not need to optimize for this case really. I feel that the
> odds of installing Gentoo where you have no GUI (via either the LiveDVD or
> SystemRescueCD), no smartphone to use to look at the wiki, no tablet to use
> to look at the wiki (I'm not sure about elsewhere, but here in the US, you
> can get a brand-new Android tablet for $40 USD at a physical store (less
> online) and in the UK you can find them under 50GBP), no spare computers to
> use to look at the wiki are extremely unlikely.

And it's not like the wiki is unusable in a text-based browser like
elinks. It may be a little more inconvenient, but we are really
talking about corner cases here.

-- 
Cheers,

Ben | yngwin
Gentoo developer


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [gentoo-project] Gentoo Handbooks moving to the wiki
  2014-12-12 15:30 [gentoo-project] Gentoo Handbooks moving to the wiki Sven Vermeulen
  2014-12-12 15:44 ` Manuel Rüger
  2014-12-13 13:05 ` Alexander Berntsen
@ 2014-12-20 21:40 ` Tom Wijsman
  2 siblings, 0 replies; 28+ messages in thread
From: Tom Wijsman @ 2014-12-20 21:40 UTC (permalink / raw
  To: Sven Vermeulen; +Cc: gentoo-project

On Fri, 12 Dec 2014 15:30:40 +0000
Sven Vermeulen <swift@gentoo.org> wrote:

> copy the current Gentoo Linux handbooks to the Gentoo Wiki

That's awesome news! Congratulations. Thank you... :)


^ permalink raw reply	[flat|nested] 28+ messages in thread

end of thread, other threads:[~2014-12-20 21:41 UTC | newest]

Thread overview: 28+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-12-12 15:30 [gentoo-project] Gentoo Handbooks moving to the wiki Sven Vermeulen
2014-12-12 15:44 ` Manuel Rüger
2014-12-12 17:00   ` Sven Vermeulen
2014-12-13 13:05 ` Alexander Berntsen
2014-12-13 14:55   ` Ulrich Mueller
2014-12-13 15:40     ` Sven Vermeulen
2014-12-13 15:41       ` Alexander Berntsen
2014-12-13 15:53       ` Rich Freeman
2014-12-13 16:02         ` Alexander Berntsen
2014-12-13 16:27           ` Ciaran McCreesh
2014-12-13 16:34             ` Alexander Berntsen
2014-12-13 17:03               ` Rich Freeman
2014-12-13 18:35             ` Andreas K. Huettel
2014-12-14 13:11               ` Markos Chandras
2014-12-13 19:47       ` Sven Vermeulen
2014-12-14 13:57   ` Ben de Groot
2014-12-14 13:59     ` Alexander Berntsen
2014-12-14 14:04       ` Ben de Groot
2014-12-14 14:22         ` Andrew Savchenko
2014-12-14 14:45           ` Matthias Maier
2014-12-14 15:18             ` Rich Freeman
2014-12-14 15:02           ` Jeff Horelick
2014-12-14 15:19             ` Andrew Savchenko
2014-12-14 19:46               ` malc
2014-12-14 20:31                 ` Andrew Savchenko
2014-12-15  8:11                   ` Sven Vermeulen
2014-12-15 11:25             ` Ben de Groot
2014-12-20 21:40 ` Tom Wijsman

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox