Finished Rewriting "Getting Started With Development" for Elgg

I finished a rewrite of the"Getting Started with Development" guide on the Elgg wiki site. The previous version left out some key stuff that a developer wants to know right away (like what Javascript library Elgg uses). It also jumped down into the details too often for an overview. You can find the new version here: http://docs.elgg.org/wiki/Getting_Started_With_Development

Please take a moment to read it over, think back to when you were new to Elgg: what's missing? Where is it weak?

  • Hey Cash, I like your improvements.  You cover all the important stuff high level but then link to the details if people want to learn more.

    My thoughts on the docs for beginners,  as I recently was one myself...

    I'm a "learn by examples" kind of guy, so one of my main complaints about the Elgg docs is the fact that examples either don't exist, have gaps in the code or the explanation, or don't work if you copy the code into your own plugin.

    Your page does link to the tutorials...but I do remember being hella-confused trying to understand them when I first started out.  They contain snippets of code but never a link to complete PHP files...even a plugin ZIP that you can install and run yourself for each tutorial would be awesome.

    Maybe I'm just slow though? ;)

  • I'll definitely look into writing more tutorials. So far I have rewritten the blog tutorial so that it actually works.

  • Hello Cash,

    I did a quick review, its so much better, nice work.

    I would suggest to add the specific instructions in regards to working with CSS, since this is a very common stumbling block for new developers and designers. Something like:

    Important Note: Whenever working with plugins, specially views and CSS, please make sure that you disable the views cache system in the administration section, and delete the view_paths the file in your files folder.

    Also, it would be nice to mention the SVN, Trac, and where to find a roadmap of new features in Elgg, so that programmer doesn't endeavor for a plugin too passionately if its already being developed as core.

    Regards,
    Uddhava dasa

  • Thanks, Uddhava - I tried to address your concerns. No luck on the roadmap since it doesn't exist right now.

  • Sounds good. Hopefully more people will add good content to the docs.

Feedback and Planning

Feedback and Planning

Discussions about the past, present, and future of Elgg and this community site.