Sort out the documentation about umbraco-ditto HOT 10 CLOSED

I'm getting better at jekyll if you want to use that.

from umbraco-ditto.

Yeah, we used Jekyll/GitHub Pages for the uComponents doco - it worked out pretty good for us.

I guess it's all the other stuff that comes with it... design, markup, etc. I dare not mention using a pre-built bootstrap template ;-)

from umbraco-ditto.

I resign! 👅

from umbraco-ditto.

I've created the gh-pages branch and copied over the layout/basis from @JimBobSquarePants's ImageProcessor doco site.

http://leekelleher.github.io/umbraco-ditto/

Next up to write actual documentation! :-)

from umbraco-ditto.

👍 Good man! Looks great!

Definitely stick to markdown as much as possible. I regret not using it from the start with the IP docs. It's been painful switching over.

from umbraco-ditto.

I've been taking a look at Read the Docs this evening... it looks quite promising!

Project page: https://readthedocs.org/projects/umbraco-ditto/
Docs: http://umbraco-ditto.readthedocs.org/en/develop/

I'm testing it out with the MkDocs engine.

from umbraco-ditto.

Anything that makes writing docs easier gets my vote 👍

from umbraco-ditto.

Let's go with Read the Docs! It lets us focus more on the documentation than presentation/styling - which is what I ended up spending a load of time on with the GitHub Pages one.

With RTD, I like that we can have docs per version and it's all within the one repo (with branches/tags).

I'll take a look to see if I need to give you guys any permissions on the RTD side of it... but I think it's a case of update the markdown files in the /docs folder and commit/push to GitHub - then there's a webhook that triggers RTD.

If you want to see if the docs build was successful, I think that page is openly accessible:
https://readthedocs.org/builds/umbraco-ditto/

from umbraco-ditto.

re: RTD permissions - if you do need access, then sign up on RTD, then give me your username. I can add you as a Maintainer. ta-dah 🎉

from umbraco-ditto.

Going to close this issue, as we'll give RTD a go - it looks like the best place to host docs.

Next up is to write the docs. We can open separate issues for specific documentation topics.

from umbraco-ditto.