← Back to team overview

maria-developers team mailing list archive

Sphinx and other storage engines documentation



this the log from a short discussion about how to provide the
documentation for Sphinx to our users. Can you think of some
easy way to automate at least the notification process that
the docs changed?

<timour> knielsen, shodan IMHO it wuold be best if Sphinx could notify us automatically about changes in the docs, rather than having a possibly outdated documentation, with a link to the up-to-date docs.
<timour> If we take this manual approach to copy/paste docs for a dozen storage engines, we will end up in a big mess.
<shodan> timour: would http://code.google.com/feeds/p/sphinxsearch/svnchanges/basic do for notifications?
<timour> shodan, isn't that a feed with all changes?
<shodan> timour: yes, and so doc/ changes are there too
<timour> knielsen, perhaps we could pull the docs automatically?
<shodan> timour: maybe we could setup a special hook on commits to just doc/ but def not to a specific section
<timour> shodan, I think we have to ask our docs guy what is the best way to at least be automatically notified of doc changes (for the same release).
<timour> To me there are 2 kinds of doc changes:
<timour> - improvements of the docs for the same version of the code,
<timour> - changes due to a new release.
<timour> The latter will be straightforward, because we will know when we release a new version of Sphinx, but not the former.

What do you think about the problem with outdated docs of storage engines?


Follow ups