collective / collective.transmogrifier

A configurable pipeline, aimed at transforming content for import and export
Other
5 stars 8 forks source link

Add sphinx-based documentation. #3

Closed tisto closed 10 years ago

tisto commented 10 years ago

@mjpieters what's the current status of collective.transmogrifier? Is the collective repo the right place to commit to?

I would like to add a sphinx-based documentation that can be included in the new plone docs. Is that ok with you?

mjpieters commented 10 years ago

I'm distrustful of the collective process to keep the package focused, I must say. But then again I am also being a lazy maintainer and not doing enough to keep the package up-to-date and released regularly.

But seeing Ross has taken over maintenance here I'll just have to concede and let go, I guess!

tisto commented 10 years ago

@mjpieters I agree that the collective process is far from perfect. Thanks for the quick reply!

@rpatterson Would you mind reviewing my pull request? I basically moved all docs/doctests to a new sphinx-based documentation according to our new docs best practices (so we can include the transmogrifier docs in the plone docs). cc @svx @polyester

polyester commented 10 years ago

I'll work with the docteam to see where we best place it in docs.plone.org. Thanks, this'll make a very good addition to the docs!

svx commented 10 years ago

After a first quick look, maybe to: http://docs.plone.org/working-with-content/ ? It will be a bit tricky since this is also really interesting for people who are looking for migrations I guess

djowett commented 10 years ago

@svx A strong (but friendly) "No" to that suggestion. That section is ideal for directing my website users to & to remain friendly to them it needs to stay clear of Developer level docs like Transmogrifier (IMVHO). I'm all for the docs landing in the right place though.

polyester commented 10 years ago

djowett, 100% agree. But let's not have that discussion here. Docs-list please... or maybe even better https://github.com/plone/documentation/issues/59

polyester commented 10 years ago

now integrated into docs: http://docs.plone.org/develop/import/index.html