I wrote a draft doc for app-admin/logcheck, a replacement for logsentry
that has a built-in database of rules and an active upstream. See
<http://dev.gentoo.org/~phajdan.jr/logcheck.xml>. It would be great if
it could become at some point a part of the official documentation. I'm
the maintainer of the package and use it on about 3 Gentoo installations.

What should I do to make it included in the official docs? I think one
of the steps is filing a bug, but it seems that there may be some
discussion first what is missing or wrong in the current draft, which
may be easier to do in a mailing list and not bugzilla.

Paweł Hajdan jr

On Tue, 23 Feb 2010 21:39:37 +0100
"Paweł Hajdan, Jr." <phajdan.jr@gentoo.org> wrote:

> I wrote a draft doc for app-admin/logcheck, a replacement for logsentry
> that has a built-in database of rules and an active upstream. See
> <http://dev.gentoo.org/~phajdan.jr/logcheck.xml>. It would be great if
> it could become at some point a part of the official documentation. I'm
> the maintainer of the package and use it on about 3 Gentoo installations.
>
> What should I do to make it included in the official docs? I think one
> of the steps is filing a bug, but it seems that there may be some
> discussion first what is missing or wrong in the current draft, which
> may be easier to do in a mailing list and not bugzilla.
>
> Paweł Hajdan jr
>

The package also has to be stabilized on its architectures, as we don't document ~arch stuff.

On 2/24/10 12:03 AM, Joshua Saddler wrote:
> On Tue, 23 Feb 2010 21:39:37 +0100
> "Paweł Hajdan, Jr." <phajdan.jr@gentoo.org> wrote:
>> I wrote a draft doc for app-admin/logcheck, a replacement for logsentry
>> that has a built-in database of rules and an active upstream.
> The package also has to be stabilized on its architectures, as we don't document ~arch stuff.

I see. I had to write some kind of docs so it could be arch-tested. It
probably won't go stable too soon because it's in portage for only two
months. I'll come back when it gets stabilized.

By the way, I enhanced http://dev.gentoo.org/~phajdan.jr/logcheck.xml
with Mathew Summers' suggestions on #gentoo-doc (not all of them yet).

As the package is going to take some time to stabilize, is it acceptable
to link to my ~ page on dev.gentoo.org in an elog message?

Paweł Hajdan jr

On Wed, 24 Feb 2010 11:26:53 +0100
"Paweł Hajdan, Jr." <phajdan.jr@gentoo.org> wrote:
> As the package is going to take some time to stabilize, is it acceptable
> to link to my ~ page on dev.gentoo.org in an elog message?

Sure. I may have a patch for you soon with some minor GuideXML fixes, so ping me if you don't get one in a week or so.

On 2/24/10 12:05 PM, Joshua Saddler wrote:
> On Wed, 24 Feb 2010 11:26:53 +0100
> "Paweł Hajdan, Jr." <phajdan.jr@gentoo.org> wrote:
>> As the package is going to take some time to stabilize, is it acceptable
>> to link to my ~ page on dev.gentoo.org in an elog message?
>
> Sure. I may have a patch for you soon with some minor GuideXML fixes, so ping me if you don't get one in a week or so.

Pinging you then. By the way, I have opened a stabilization bug and
we're getting some first Arch Testers' reports. It would be nice to get
the GuideXML quite ready for the inclusion.

Paweł

On Sun, 09 May 2010 19:37:35 +0200
"Paweł Hajdan, Jr." <phajdan.jr@gentoo.org> wrote:
> Pinging you then. By the way, I have opened a stabilization bug and
> we're getting some first Arch Testers' reports. It would be nice to get
> the GuideXML quite ready for the inclusion.

Actually, it looks pretty good. You musta cleaned it up. Only a couple of things left:

1. In CL 1.5, add parentheses around the RED comment text, just like you did in CL 1.4.

2. Just to make it more clear, change "${EDITOR}" in CL 1.6 to "nano -w" -- we generally use nano for basic editing examples. Experienced users will already be using a different tools, but inexperienced users might not know what ${EDITOR} is.

3. Maybe add <c> tags around each instance of logcheck where it is referred to as a program name. For the *user* "logcheck" you can leave it as-is. You might also want to enclose syslog-ng in <c> tags, too, before CL 1.3.

4. MOST IMPORTANT: do **not** do "echo app-admin/logcheck ~arch >> whatever"
- This is wrong! You NEVER add the ~arch keyword!! Just list app-admin/logcheck in package.keywords. This applies to any package in Portage.
- So CL 1.2 should be:

# <i>echo app-admin/logcheck >> /etc/portage/package.keywords</i>

-----

Open a GDP bug once logcheck is stabilized, and we can add the revised guide to /doc/en/

On 5/9/10 9:38 PM, Joshua Saddler wrote:
> On Sun, 09 May 2010 19:37:35 +0200
> "Paweł Hajdan, Jr." <phajdan.jr@gentoo.org> wrote:
>> By the way, I have opened a stabilization bug and
>> we're getting some first Arch Testers' reports. It would be nice to get
>> the GuideXML quite ready for the inclusion.
>
> Actually, it looks pretty good. You musta cleaned it up. Only a couple of things left:
> [...]
> Open a GDP bug once logcheck is stabilized, and we can add the revised guide to /doc/en/

Thanks! Now app-admin/logcheck is stable on x86 and amd64 (still ~ppc,
hopefully that's fine).

I've submitted https://bugs.gentoo.org/show_bug.cgi?id=322223 and
attached the suggested GuideXML. Could you take another look at it?