plone / papyrus

A buildout to run multiple versions of the plone documentation
GNU General Public License v2.0
8 stars 7 forks source link

todo: Plone 5 change loactions of includes #40

Closed svx closed 9 years ago

svx commented 9 years ago

reason: to avoid urls, with external in it, like api, cmf and so on.

the idea so far is start with that from Plone 5 on, with doing that we wil not mess up search and seo for Plone 3 and Plone 4 docs.

svx commented 9 years ago

We have to rethink, our current includes from external docs, our current setup works fine for 'non core' docs, since they go into /external but this implementation is not great for 'core docs'. I want to put 'core docs' not under /external but where they belong, like for example /develop/addons/bobtemplates. Further and this is not an issue here, but in some 'core add-ons', we have to make sure that they follow http://docs.plone.org/about/documentation_styleguide_addons.html#id2, which is not the case yet, with for example: https://github.com/plone/bobtemplates.plone

polyester commented 9 years ago

There's no structural reason we're putting external docs under /external, it just makes it clear that these are not to be found in the repo, and need to be edited elsewhere. But if it's a 'core' add-on, it for sure can be included directly in the right place.

But: I would make it a condition then that the add-on follows the styleguide. This is not a nice-to-have, but a condition.

svx commented 9 years ago

Yes, that is exatly what we have with for example bobtemplates, that is why I opened: https://github.com/plone/bobtemplates.plone/issues/34

svx commented 9 years ago

ok ! will close that now, everything is clear and sorted out