I'm wondering if the protocol docs can be auto-generated from our code to a
large extent. Or if we can enhance our protocol definition classes a bit to
make them self-documenting (the way we did for configuration).

Regarding Dana's suggestion: I think you need special wiki-edit privileges.
If you don't see the "edit" bottom, I'd ask in "dev" list for that
privilege (sorry, looks like I'm not a wiki admin, so I can't add you).

On Mon, Jan 18, 2016 at 7:46 AM, Ismael Juma <ism...@juma.me.uk> wrote:

> In addition to this, it would be great to move the protocol docs to the
> docs folder of the git repo:
>
> https://github.com/apache/kafka/tree/trunk/docs
>
> This way, we can ensure that the protocol docs are updated at the same time
> as the protocol code.
>
> Ismael
>
> On Mon, Jan 18, 2016 at 3:36 PM, Dana Powers <dana.pow...@gmail.com>
> wrote:
>
> > Not exactly - there is some documentation in the source code, but I agree
> > that a wiki on this would be extremely useful.
> >
> > Can anyone create a wiki page? If so, I'm happy to get something started.
> > It is really the missing piece for folks writing custom clients /
> anything
> > at the api layer.
> >
> > -Dana
> > On Jan 18, 2016 04:07, "Muqtafi Akhmad" <muqt...@traveloka.com> wrote:
> >
> > > dear all,
> > >
> > > I found a guide in Kafka protocol (Kafka Protocol Guide
> > > <
> > >
> >
> https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-OffsetRequest
> > > >),
> > > the guide describes API calls complete with their request and response
> > > format, and list of error codes with their description . My question
> is,
> > is
> > > there documentation of possible error code mapping for each API
> request?
> > >
> > > Thank you,
> > >
> > > --
> > > Muqtafi Akhmad
> > > Software Engineer
> > > Traveloka
> > >
> >
>

Reply via email to