Hi folks:

I'd like to propose breaking out a nuymber of our documents into their
own repos.

My thinking is that specifically; the release notes, midonet, and
niciranvp documentation shares very little with the rest of the
documentation, and should be broken out akin to how the QIG is
currently broken out.

The particular problem I am trying to solve is to deal with
publishing. For instance, even though the release notes are contained
in just a few xml documents, it copies content from every single xml
file in thd directory - over 400 - and it also copies those up to the
website.

Splitting things up also allows us to prioritize l10n. Right now, we
just dump 400 xml files worth of content into transifex and people
translate away - they can't put a priority on release notes, or
de-emphasize more esoteric documentation like Nicira or Midonet.

Eventually I'd like to break out each of the individual guides into
their own document - separate from the other. Right now they carry a
ton of similar content so that isn't very practical; but it's what I
am thinking, perhaps for 4.4 or 4.5.

In the meantime, I'd like to make this change as soon as we think we
have documentation pretty close to done for 4.2 to minimize the
disruptive effects.

Thoughts, comments, flames?

--David

Reply via email to