RFC pod2rst docs changes

Dylan Hardison dylan at mozilla.com
Tue Sep 6 14:08:31 UTC 2016

> On Sep 6, 2016, at 03:08, Jeff Fearn <jfearn at redhat.com> wrote:
> Hi, using RST bugs me and having the docs split between two UIs bugs me,
> the solution, pod2rst.

rst for *user* facing documentation is pleasant enough (to write, at least).

> Note the poor choice of title for this section ^_^
Integration is the right section, perhaps the title should be "Bugzilla Internals".

> I copied a couple of extensions in to the upstream 5.0 branch just for
> demonstration.
> I note that none of the extensions get added to the search, going to
> have to figure that one out.
> It'd be nice to put the WebServer docs in to the API docs, but should
> they go in both places?
> It's also be nice if we had a standard way of doing User and admin docs
> in the extension pod, and putting that in the right guide.
I think user and admin docs should be in rst, even for extensions. But we can discuss this more.

> What I like about that is all the information would be available both in
> the POD and in the web docs, so you could always find all the docs.

when you say "all the docs" you mean "all the internal API stuff will be in both places",
right? The user documentation is solely in rst format and that's not going to change.
Cédric would flip a table if we changed the doc format again. :-)

I think this is a good direction, ensuring that the perl internals end up being equally accessible in either format.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 2290 bytes
Desc: not available
URL: <http://lists.bugzilla.org/pipermail/developers/attachments/20160906/649ae92d/attachment.p7s>

More information about the developers mailing list