Re: Canonical jhbuild documentation

On Wed, Feb 11, 2015 at 4:33 AM, Allan Day <allanpday gmail com> wrote:
Sriram Ramkrishna <sri ramkrishna me> wrote:
Seems like you should talk this through with Carlos and Ryan - they're
the effective maintainers of the wiki pages in question. I know that
Carlos is keen to reduce the amount of duplication.

Yes, I sent this email after consulting with him and Fred.

I assume that "him" is Carlos? Maybe you should talk to Ryan also, if
that's the case.


People will always come across the official manual on, since this ranks highly in search results. So, if
you really want people to easily find the introductory documentation,
it will have to live as a part of the official manual. I get the
impression that there has been resistance to this in the past, due to
the desire to keep Jhbuild as a somewhat generic tool. However, I
don't see how the two use cases (Jhbuild for new GNOME contributors,
and Jhbuild for everyone else) couldn't be satisfied by structuring
the manual according to audience.

This is precisely what I'm advocating.

Um, I don't think it is. You originally said:

"So Proposal is:

is the only documentation on, the rest gets retired and
merged into jhbuild documentation."

What I'm suggesting, and what Fred and Carlos seem to have done, is
that BuildGnome gets merged into the official manual. This makes the
manual the canonical place for documentation, whether it is for new
GNOME contributors, or for more generic JHBuild usage.

Ah, sorry I was confused.  I think the reason I was confused is that
the documentation BuildGnome is separate wiki space from the manual.
So while maybe that content is in the manual it wasn't obvious to me
from what was presented.

I think though, as someone else further in the thread said, we want to
make a distinction between 'quick start' and the manual.

So, let's try to get something actionable.  Do folks agree that we
should have two pieces - the manual and the quick start where the
quickstart is the BuildGnome documentation maintained by Carlos and
the JHBuild manual supported by the community.

If we agree, then we can work with the folks in gnome-love to archive
the old documentation and merge the content into the manual.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]