On Nov 16, 2013, at 5:46 PM, Leif Hedstrom <[email protected]> wrote:
>
>
> which seems reasonable. However, I have a few questions on this:
Bah, email ate my formatting. This is how I wanted the questions to look:
* Do we create one page / file for every plugin API? Or do we try to group them
together by some logic (things logically belonging together, like TSmalloc and
TSfree)? If there's a group, what do the file get named, and how do we make the
grouping such that we all agree and work on the same grouping?
* How does this relate to the docs in docs/sdk, e.g. docs/sdk/mime-headers? Do
we add or change links / referencesin docs/sdk over to the reference/api
sections?
* Do we also have to produce a man page, or is that what reference/api is all
about?
Poking around some more, I see several pages which does the grouping. As such,
I'm wondering if e.g. TSUrlCreate.en.rst should be renamed to just TSUrl.en.rst
? And if that's the case, we ought to put all TSMimeHdrField* APIs into one
page, TSMimeHdrField.en.rst ?
Looking at the list, the natural grouping / renaming (of what we have) would be
TSHttpParser
TSHttpTxnMilestone
TSIOBuffer
TSMBuffer
TSPlugin
TSRemap
TSUrl
Other sections would probably look nicer with a more generic / descriptive
title, e.g. "Debugging", "Hooks", "Remap Plugins", "Life Cycles" etc. But then
maybe the above ought to be renamed too, e.g. "HTTP Parser", "Milestone
metrics" and other descriptive names.
Thoughts?
-- Leif
