As someone who has just recently started learning how to make changes to a shindig implementation, I can say that it took me months to get to a point where I understood anything in the codebase.
The main problem for me was that when you go to the main shindig site, there is not a good ³how do I get started² section. After struggling, I eventually found some useful documentation. I feel as though a good start would simply be to add a ³how to get started² link to the _main_ site with a link to a wiki entry. I do agree that a full implementation guide is needed, but as a start this might be good. If others think it¹s a good idea, I would be happy to create that wiki entry with my information as a starting point if someone can give me access to the wiki. From there others can edit/improve. -Matt On 9/16/14, 8:31 AM, "Chris Spiliotopoulos" <chrysanthos.spiliotopou...@gmail.com> wrote: >Hi all, > >regarding the implementation guide Ryan mentioned, I have the need to say >that after using Shindig / OpenSocial for a few years now - and it's a >core >module in nearly everything I create - I think that the main problem is >the >lack of organization regarding resources in general. IMHO, it's very >disappointing after so many years in existence as a project, not to have a >central dedicated place for all things OpenSocial. I can't understand why >some docs are still under Google's dev site, some under Atlassian's and >some under Shindig? For starters, OpenSocial's site should be the central >point of reference and act as an umbrella to other sub-resources (Shindig, >etc). That was point #1. > >Point #2 is about the user experience from all the sites. Everything >looks >so 'dead' and 'old'. No wonder that every time I talk to devs and >evangelize OpenSocial and gadgetized development, after looking at the web >site they can't seem to understand anything and by correlating to other >modern web sites - e.g. for NodeJS projects - they think that this >framework is not supported any more (btw, someone asked in Quora this >question 2 years ago). > >I wanted to take the initiative a few months ago and suggest we should >make >an effort and bring OpenSocial officially back to life, in a way that it >is >modernized and new devs will start to know it. My main concern is that >with so many cluttered and outdated resources, I'm not quite sure what >should come first. Probably a decision from the people behind these >projects to decide on which should be the central point of reference. > >It's really a pity for such useful frameworks / specs not to have the home >they deserve... Just to sum up, I think there is no point in adding extra >technical material if developers cannot find it easily, understand it and >come back again for more. > >Best regards, >Chris > > > >On Tue, Sep 16, 2014 at 3:08 PM, Ryan Baxter <rbaxte...@apache.org> wrote: > >> I think it has become clear that we should really be providing an >> implementation guide for those who want to consume Shindig. Those of >> us that have gone through the pain of implementing Shindig know that >> there are a lot of gotchas along the way, and it is not entirely >> obvious which pieces of Shindig are production ready by default and >> which pieces should be replaced with your own implementations. It >> would also be good to enumerate which configuration options need to be >> changed in order to properly secure Shindig (locked domains). What >> does everyone think? This will need to be a true community wide >> effort as I am sure everyone has their own tips and tricks. >> Appreciate any feedback, as well volunteers to help. >> >> -Ryan >> > > > >-- >Chris Spiliotopoulos > >Solutions Architect
