Docs migration update
By Evan Winslow
Just converted a huge chunk of docs to rST. These were all the ones that I had in Google docs. I didn't really bother rewriting them so much as just get them into rST format.
One realization that came out of this was that I really think we should host the docs on readthedocs.org. Here are my reasons:
- They have CNAME support so the canonical urls can still be at docs.elgg.org if we want
- Updates happen after every commit via webooks, not just once per day
- Out-of-box support for multiple parallel versions
- Automatically generates alternate (downloadable) formats like PDF, ePub, etc.
Decisions that I need your input on:
- Does the core team agree regarding canonical docs on http://readthedocs.org?
- Do we want to do the CNAME thing to keep the url at docs.elgg.org?
- When can we kill the wiki entirely?
Feedback and Planning
Discussions about the past, present, and future of Elgg and this community site.
At first glance had mixed feelings, but learn is fine with me. I wouldn't say that docs should be only about learning, but let it be learn.elgg.org.
Just attached subdomain: http://learn.elgg.org/
nice one but 1.9 is not yet released .
@rubon We consider releasing 1.9 and creating the documentation for 1.9 one and the same process. Only a small fraction of people (the experts) would benefit from 1.9 if there were no documentation about it. This is why we want to have the new documentation running and up-to-date before releasing 1.9.
Thanks, Pawel!
Methinks we need a nicer theme... Actually the theme that read the docs uses for its own docs is pretty nice. And mobile friendly too. I know cash worked on one back in the day but I don't recall if it had mobile support.
https://docs.readthedocs.org/en/latest/index.html
Yes, we definitely need a nicer theme.
@evan awesome design ......
Yup ur right Juho:D i will agree
juho one more thing can u change rubon to sathish can u ?
[merged 3 comments - Srokap]
Woot. New theme is live at http://learn.elgg.org/. No excuse not to write great documentation now!
Looks grt @evan :D
It's awesome, well done Evan!
- Previous
- 1
- 2
- 3
- Next
You must log in to post replies.