You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by Ryan Baxter <rb...@apache.org> on 2014/09/16 14:08:15 UTC
Implementation Guide
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
AW: Implementation Guide
Posted by René Peinl <re...@hof-university.de>.
I absolutely agree that this would be a huge benefit for other people.
Apropos production ready:
What happened to our neo4j backend?
https://issues.apache.org/jira/browse/SHINDIG-1911
My last information in April 2014 was, that it should become part of the Shindig source. Still the issue is unresolved. As far as I know it's the only production ready database backend Shindig has.
Regards
René
-----Ursprüngliche Nachricht-----
Von: Ryan Baxter [mailto:rbaxter85@apache.org]
Gesendet: Dienstag, 16. September 2014 14:08
An: dev@shindig.apache.org
Betreff: Implementation Guide
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
Re: Implementation Guide
Posted by "Merrill, Matt" <mm...@mitre.org>.
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"
<ch...@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 <rb...@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
Re: Implementation Guide
Posted by Chris Spiliotopoulos <ch...@gmail.com>.
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 <rb...@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
Fwd: Re: Implementation Guide
Posted by Ron Wheeler <rw...@artifact-software.com>.
Just to show that we are not the only Apache project trying to make
sense of documentation.
Ron
-------- Original Message from Shindig project--------
Hi all,
the question is how we should balance the material between Apache CMS and
Confluence. I think that all technical guides and resources should go into
Confluence - making it the official documentation space, rather than just a
wiki - and all the high-level reference / 'marketing' / news material into
the web site.
I'm having a look at different Bootstrap themes in order to select a few,
submit the initial list and let the people involved decide. As I've
already said, I think we should use a vibrant theme that shouts "Hey, have
a look inside. It's good stuff!" therefore my attention is grabbed by
'landing page' / 'agency' parallax type themes.
One thing that is missing though, is a kick-ass Shindig logo. Is someone
willing to create one? Raj, if you could suggest a Bootstrap theme that
would be great.
In the following days, I'll post a selection of themes as a reference and
we can vote. Also, I'll try and write down a suggested link structure for
the new site and also a scaffolding for the technical docs in Confluence.
Let me know what you think.
Cheers,
Chris
On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org> wrote:
> OK well for reference check out the website docs [1]. Let me know if
> you have any problems.
>
> [1] http://shindig.apache.org/documentation_website.html
>
> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <ra...@gmail.com>
> wrote:
> > Hi Ryan,
> >
> > In my work place i am using Confluence. so i don't think there will be
> > problem to me.
> >
> > Regards,
> > Raj
> >
> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com> wrote:
> >>
> >> Chris and Raj, appreciate you both stepping up! Are you familiar with
> >> how to use Apache CMS to edit the Shindig site?
> >>
> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <ra...@gmail.com>
> >> wrote:
> >> > I am also in.
> >> > though i am new here but ready to help wherever i can.
> >> >
> >> > Thank you for this great step.
> >> >
> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >> >
> >> >> Hi all,
> >> >>
> >> >> I am willing to take the first step forward on this but I expect all
> >> >> the
> >> >> people in this group to contribute / suggest / vote on important
> things
> >> >> that will make the Shindig project come back to life and start
> >> >> receiving
> >> >> attention. Based on the steps that Ryan suggested:
> >> >>
> >> >>
> >> >> > *1. We use the Shindig site as the place to keep the
> documentation.
> >> >> > It
> >> >> is
> >> >> > CMS based [1] so no need to know how to write HTML.*
> >> >>
> >> >>
> >> >> First we need to decide on an awesome & clean theme for the website
> >> >> that
> >> >> will be responsive and attractive. As Bootstrap is already being
> used
> >> >> that
> >> >> should be no prob, but we need to use a theme that will rock. Please
> >> >> suggest themes from other sites that you find attractive and user
> >> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/>
> theme
> >> >> very clear for reading. Also, if someone could deal with the art
> work
> >> >> that
> >> >> would be very useful.
> >> >>
> >> >>
> >> >>
> >> >> >
> >> >> > *2. We create a getting started guide, containing the minimal set
> >> >> > of steps to get someone up and running.*
> >> >>
> >> >>
> >> >> >
> >> >> > *3. We create a detailed implementation guide that addresses how
> >> >> > someone
> >> >> > would extend Shindig to build their own implementation.*
> >> >>
> >> >>
> >> >> Next, we need to make a map of the current structure of the web site
> >> >> and
> >> >> then suggest alternatives on how the new site should be structured.
> >> >> The
> >> >> key here is that it should be self explanatory and guide you
> >> >> step-by-step
> >> >> on how to do from the simplest to the most advanced task. Newcomers
> >> >> should
> >> >> feel comfortable with it so that they start with an appetite to learn
> >> >> more
> >> >> about this project.
> >> >>
> >> >> This part requires an initial gathering of all existing resources and
> >> >> cleansing. Everything should be relevant to the latest version
> >> >> of the framework. A few months ago I had created a GitHub project
> >> >> <https://github.com/theChefArchitect/os-examples-container-embedded>
> >> >> with
> >> >> a
> >> >> sample embedded container in a Spring web app written for this
> purpose.
> >> >> I've also noticed that the maintenance of the PHP version has
> stopped.
> >> >> All
> >> >> these cluttered resources should be gathered in one place initially
> and
> >> >> then decide which of them should be used as a reference for the new
> >> >> documentation.
> >> >>
> >> >>
> >> >> > *4. In the process of doing this we cleanup/consolidate the
> Shindig
> >> >> > site
> >> >> > and the wiki.*
> >> >>
> >> >>
> >> >> One important thing that should be decided is where the
> documentation /
> >> >> tutorials should be hosted. At the moment the web site acts as a
> proxy
> >> >> for
> >> >> different documentation locations around the web and some hard-core
> >> >> tech
> >> >> docs live under Atlassian's Confulence site
> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the
> story
> >> >> with that? Will the documentation be hosted under Confluence or
> under
> >> >> the
> >> >> web site?
> >> >>
> >> >> Overall, this task requires collaborative effort and should be done
> in
> >> >> baby
> >> >> steps. Documentation / guides are important but then there are
> plenty
> >> >> of
> >> >> other stuff needed to make this project gain a vibrant community -
> e.g.
> >> >> gadgets hosted on the site for tutorials and show cases, API
> >> >> documentation
> >> >> / integration, social media presence, etc.
> >> >>
> >> >> Looking forward to your responses.
> >> >>
> >> >> Cheers,
> >> >> Chris
> >> >>
> >> >>
> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org>
> >> >> wrote:
> >> >>
> >> >> > Does anyone feel especially passionate about this topic and want to
> >> >> > step up and take the lead on this?
> >> >> >
> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
> >> >> wrote:
> >> >> > > Hi Ryan,
> >> >> > >
> >> >> > > This sounds like a really great start. I'm sure a clean and clear
> >> >> > getting started guide + detailed implementation guide that can be
> >> >> > easily
> >> >> > located on the Shindig site will make a huge difference on the
> >> >> > take-up of
> >> >> > this impressive framework.
> >> >> > >
> >> >> > > Kind regards,
> >> >> > >
> >> >> > > Darren
> >> >> > >
> >> >> > >
> >> >> >
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >> Chris Spiliotopoulos
> >> >>
> >> >> Solutions Architect
> >> >>
> >
> >
>
--
Chris Spiliotopoulos
Solutions Architect
Re: Implementation Guide
Posted by Chris Spiliotopoulos <ch...@gmail.com>.
Darren, thanks for the contribution proposal - sounds great! IMO the logo
should express plug-ability (gadgets) & social connectivity (OpenSocial
APIs).
René, to be honest I had you in mind! I had been watching closely all the
discussion at the time regarding your contribution and I think it
would be more than great to write a tutorial on this.
On Thu, Oct 9, 2014 at 10:38 AM, René Peinl <re...@hof-university.de>
wrote:
> Hi Raj,
> we are using Shindig in our project for collecting events from Liferay,
> XWiki, Alfresco and OpenXchange and presenting them as an Activity Stream
> inside a Liferay portlet. We are using the neo4j Backend we contributed as
> a storage solution. This allows us to offer social networking that provides
> friend suggestions and shows the shortest path between two people not
> directly connected, both as a Liferay portal.
> I could contribute a case description to the implementation guide, if you
> like.
> A demo with these systems will be available early 2015 I guess.
> Regards
> René
>
> -----Ursprüngliche Nachricht-----
> Von: Raj Janorkar [mailto:raj.janorkar@gmail.com]
> Gesendet: Donnerstag, 9. Oktober 2014 01:53
> An: dev@shindig.apache.org
> Betreff: Re: Implementation Guide
>
> Hi Ryan,
>
> I think we need
>
> 1) Great Logo for shindig
> 2) Attractive yet simple template for doco.
> 3) Few shindig implementations on web, this will help users to understand
> how shindig work and what extend it can be enhanced.
>
> These will help shindig to attract new users/developers.
>
> Sorry i do not have skill to develop logo. If we dont get any i am happy
> to find some font which will look good for name "shindig", let me know.
>
>
> Regards,
> Raj
>
> On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org> wrote:
>
> > Chris many other popular apache projects keep the project
> > documentation on the project site....take a look at Apache HTTP,
> > Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
> > over to Apache CMS or not but I would rather stick with the
> > convention.
> >
> > Agree on a new logo, if anyone has the skills to come up with one that
> > would be great.
> >
> > On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
> > <ch...@gmail.com> wrote:
> > > Hi all,
> > >
> > > the question is how we should balance the material between Apache
> > > CMS and Confluence. I think that all technical guides and resources
> > > should go
> > into
> > > Confluence - making it the official documentation space, rather than
> > just a
> > > wiki - and all the high-level reference / 'marketing' / news
> > > material
> > into
> > > the web site.
> > >
> > > I'm having a look at different Bootstrap themes in order to select a
> > > few, submit the initial list and let the people involved decide. As
> > > I've already said, I think we should use a vibrant theme that shouts
> > > "Hey,
> > have
> > > a look inside. It's good stuff!" therefore my attention is grabbed
> > > by 'landing page' / 'agency' parallax type themes.
> > >
> > > One thing that is missing though, is a kick-ass Shindig logo. Is
> > > someone willing to create one? Raj, if you could suggest a
> > > Bootstrap theme that would be great.
> > >
> > > In the following days, I'll post a selection of themes as a
> > > reference and we can vote. Also, I'll try and write down a
> > > suggested link structure
> > for
> > > the new site and also a scaffolding for the technical docs in
> Confluence.
> > >
> > > Let me know what you think.
> > >
> > > Cheers,
> > > Chris
> > >
> > > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
> > wrote:
> > >
> > >> OK well for reference check out the website docs [1]. Let me know
> > >> if you have any problems.
> > >>
> > >> [1] http://shindig.apache.org/documentation_website.html
> > >>
> > >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar
> > >> <ra...@gmail.com>
> > >> wrote:
> > >> > Hi Ryan,
> > >> >
> > >> > In my work place i am using Confluence. so i don't think there
> > >> > will be problem to me.
> > >> >
> > >> > Regards,
> > >> > Raj
> > >> >
> > >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com>
> > wrote:
> > >> >>
> > >> >> Chris and Raj, appreciate you both stepping up! Are you
> > >> >> familiar
> > with
> > >> >> how to use Apache CMS to edit the Shindig site?
> > >> >>
> > >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar
> > >> >> <raj.janorkar@gmail.com
> > >
> > >> >> wrote:
> > >> >> > I am also in.
> > >> >> > though i am new here but ready to help wherever i can.
> > >> >> >
> > >> >> > Thank you for this great step.
> > >> >> >
> > >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> > >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> > >> >> >
> > >> >> >> Hi all,
> > >> >> >>
> > >> >> >> I am willing to take the first step forward on this but I
> > >> >> >> expect
> > all
> > >> >> >> the
> > >> >> >> people in this group to contribute / suggest / vote on
> > >> >> >> important
> > >> things
> > >> >> >> that will make the Shindig project come back to life and
> > >> >> >> start receiving attention. Based on the steps that Ryan
> > >> >> >> suggested:
> > >> >> >>
> > >> >> >>
> > >> >> >> > *1. We use the Shindig site as the place to keep the
> > >> documentation.
> > >> >> >> > It
> > >> >> >> is
> > >> >> >> > CMS based [1] so no need to know how to write HTML.*
> > >> >> >>
> > >> >> >>
> > >> >> >> First we need to decide on an awesome & clean theme for the
> > website
> > >> >> >> that
> > >> >> >> will be responsive and attractive. As Bootstrap is already
> > >> >> >> being
> > >> used
> > >> >> >> that
> > >> >> >> should be no prob, but we need to use a theme that will rock.
> > Please
> > >> >> >> suggest themes from other sites that you find attractive and
> > >> >> >> user friendly. For instance, I find the SailsJS
> > >> >> >> <http://sailsjs.org/>
> > >> theme
> > >> >> >> very clear for reading. Also, if someone could deal with the
> > >> >> >> art
> > >> work
> > >> >> >> that
> > >> >> >> would be very useful.
> > >> >> >>
> > >> >> >>
> > >> >> >>
> > >> >> >> >
> > >> >> >> > *2. We create a getting started guide, containing the
> > >> >> >> > minimal
> > set
> > >> >> >> > of steps to get someone up and running.*
> > >> >> >>
> > >> >> >>
> > >> >> >> >
> > >> >> >> > *3. We create a detailed implementation guide that
> > >> >> >> > addresses
> > how
> > >> >> >> > someone
> > >> >> >> > would extend Shindig to build their own implementation.*
> > >> >> >>
> > >> >> >>
> > >> >> >> Next, we need to make a map of the current structure of the
> > >> >> >> web
> > site
> > >> >> >> and
> > >> >> >> then suggest alternatives on how the new site should be
> > structured.
> > >> >> >> The
> > >> >> >> key here is that it should be self explanatory and guide you
> > >> >> >> step-by-step on how to do from the simplest to the most
> > >> >> >> advanced task.
> > Newcomers
> > >> >> >> should
> > >> >> >> feel comfortable with it so that they start with an appetite
> > >> >> >> to
> > learn
> > >> >> >> more
> > >> >> >> about this project.
> > >> >> >>
> > >> >> >> This part requires an initial gathering of all existing
> > >> >> >> resources
> > and
> > >> >> >> cleansing. Everything should be relevant to the latest
> > >> >> >> version of the framework. A few months ago I had created a
> > >> >> >> GitHub
> > project
> > >> >> >> <
> > https://github.com/theChefArchitect/os-examples-container-embedded>
> > >> >> >> with
> > >> >> >> a
> > >> >> >> sample embedded container in a Spring web app written for
> > >> >> >> this
> > >> purpose.
> > >> >> >> I've also noticed that the maintenance of the PHP version has
> > >> stopped.
> > >> >> >> All
> > >> >> >> these cluttered resources should be gathered in one place
> > initially
> > >> and
> > >> >> >> then decide which of them should be used as a reference for
> > >> >> >> the
> > new
> > >> >> >> documentation.
> > >> >> >>
> > >> >> >>
> > >> >> >> > *4. In the process of doing this we cleanup/consolidate
> > >> >> >> > the
> > >> Shindig
> > >> >> >> > site
> > >> >> >> > and the wiki.*
> > >> >> >>
> > >> >> >>
> > >> >> >> One important thing that should be decided is where the
> > >> documentation /
> > >> >> >> tutorials should be hosted. At the moment the web site acts
> > >> >> >> as a
> > >> proxy
> > >> >> >> for
> > >> >> >> different documentation locations around the web and some
> > hard-core
> > >> >> >> tech
> > >> >> >> docs live under Atlassian's Confulence site
> > >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's
> > >> >> >> the
> > >> story
> > >> >> >> with that? Will the documentation be hosted under Confluence
> > >> >> >> or
> > >> under
> > >> >> >> the
> > >> >> >> web site?
> > >> >> >>
> > >> >> >> Overall, this task requires collaborative effort and should
> > >> >> >> be
> > done
> > >> in
> > >> >> >> baby
> > >> >> >> steps. Documentation / guides are important but then there
> > >> >> >> are
> > >> plenty
> > >> >> >> of
> > >> >> >> other stuff needed to make this project gain a vibrant
> > >> >> >> community -
> > >> e.g.
> > >> >> >> gadgets hosted on the site for tutorials and show cases, API
> > >> >> >> documentation / integration, social media presence, etc.
> > >> >> >>
> > >> >> >> Looking forward to your responses.
> > >> >> >>
> > >> >> >> Cheers,
> > >> >> >> Chris
> > >> >> >>
> > >> >> >>
> > >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
> > rbaxter85@apache.org>
> > >> >> >> wrote:
> > >> >> >>
> > >> >> >> > Does anyone feel especially passionate about this topic and
> > want to
> > >> >> >> > step up and take the lead on this?
> > >> >> >> >
> > >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
> > dbond@globalcad.com>
> > >> >> >> wrote:
> > >> >> >> > > Hi Ryan,
> > >> >> >> > >
> > >> >> >> > > This sounds like a really great start. I'm sure a clean
> > >> >> >> > > and
> > clear
> > >> >> >> > getting started guide + detailed implementation guide that
> > >> >> >> > can
> > be
> > >> >> >> > easily
> > >> >> >> > located on the Shindig site will make a huge difference on
> > >> >> >> > the take-up of this impressive framework.
> > >> >> >> > >
> > >> >> >> > > Kind regards,
> > >> >> >> > >
> > >> >> >> > > Darren
> > >> >> >> > >
> > >> >> >> > >
> > >> >> >> >
> > >> >> >>
> > >> >> >>
> > >> >> >>
> > >> >> >> --
> > >> >> >> Chris Spiliotopoulos
> > >> >> >>
> > >> >> >> Solutions Architect
> > >> >> >>
> > >> >
> > >> >
> > >>
> > >
> > >
> > >
> > > --
> > > Chris Spiliotopoulos
> > >
> > > Solutions Architect
> >
>
>
--
Chris Spiliotopoulos
Solutions Architect
AW: Implementation Guide
Posted by René Peinl <re...@hof-university.de>.
Hi Raj,
we are using Shindig in our project for collecting events from Liferay, XWiki, Alfresco and OpenXchange and presenting them as an Activity Stream inside a Liferay portlet. We are using the neo4j Backend we contributed as a storage solution. This allows us to offer social networking that provides friend suggestions and shows the shortest path between two people not directly connected, both as a Liferay portal.
I could contribute a case description to the implementation guide, if you like.
A demo with these systems will be available early 2015 I guess.
Regards
René
-----Ursprüngliche Nachricht-----
Von: Raj Janorkar [mailto:raj.janorkar@gmail.com]
Gesendet: Donnerstag, 9. Oktober 2014 01:53
An: dev@shindig.apache.org
Betreff: Re: Implementation Guide
Hi Ryan,
I think we need
1) Great Logo for shindig
2) Attractive yet simple template for doco.
3) Few shindig implementations on web, this will help users to understand how shindig work and what extend it can be enhanced.
These will help shindig to attract new users/developers.
Sorry i do not have skill to develop logo. If we dont get any i am happy to find some font which will look good for name "shindig", let me know.
Regards,
Raj
On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org> wrote:
> Chris many other popular apache projects keep the project
> documentation on the project site....take a look at Apache HTTP,
> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
> over to Apache CMS or not but I would rather stick with the
> convention.
>
> Agree on a new logo, if anyone has the skills to come up with one that
> would be great.
>
> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
> <ch...@gmail.com> wrote:
> > Hi all,
> >
> > the question is how we should balance the material between Apache
> > CMS and Confluence. I think that all technical guides and resources
> > should go
> into
> > Confluence - making it the official documentation space, rather than
> just a
> > wiki - and all the high-level reference / 'marketing' / news
> > material
> into
> > the web site.
> >
> > I'm having a look at different Bootstrap themes in order to select a
> > few, submit the initial list and let the people involved decide. As
> > I've already said, I think we should use a vibrant theme that shouts
> > "Hey,
> have
> > a look inside. It's good stuff!" therefore my attention is grabbed
> > by 'landing page' / 'agency' parallax type themes.
> >
> > One thing that is missing though, is a kick-ass Shindig logo. Is
> > someone willing to create one? Raj, if you could suggest a
> > Bootstrap theme that would be great.
> >
> > In the following days, I'll post a selection of themes as a
> > reference and we can vote. Also, I'll try and write down a
> > suggested link structure
> for
> > the new site and also a scaffolding for the technical docs in Confluence.
> >
> > Let me know what you think.
> >
> > Cheers,
> > Chris
> >
> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
> wrote:
> >
> >> OK well for reference check out the website docs [1]. Let me know
> >> if you have any problems.
> >>
> >> [1] http://shindig.apache.org/documentation_website.html
> >>
> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar
> >> <ra...@gmail.com>
> >> wrote:
> >> > Hi Ryan,
> >> >
> >> > In my work place i am using Confluence. so i don't think there
> >> > will be problem to me.
> >> >
> >> > Regards,
> >> > Raj
> >> >
> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com>
> wrote:
> >> >>
> >> >> Chris and Raj, appreciate you both stepping up! Are you
> >> >> familiar
> with
> >> >> how to use Apache CMS to edit the Shindig site?
> >> >>
> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar
> >> >> <raj.janorkar@gmail.com
> >
> >> >> wrote:
> >> >> > I am also in.
> >> >> > though i am new here but ready to help wherever i can.
> >> >> >
> >> >> > Thank you for this great step.
> >> >> >
> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >> >> >
> >> >> >> Hi all,
> >> >> >>
> >> >> >> I am willing to take the first step forward on this but I
> >> >> >> expect
> all
> >> >> >> the
> >> >> >> people in this group to contribute / suggest / vote on
> >> >> >> important
> >> things
> >> >> >> that will make the Shindig project come back to life and
> >> >> >> start receiving attention. Based on the steps that Ryan
> >> >> >> suggested:
> >> >> >>
> >> >> >>
> >> >> >> > *1. We use the Shindig site as the place to keep the
> >> documentation.
> >> >> >> > It
> >> >> >> is
> >> >> >> > CMS based [1] so no need to know how to write HTML.*
> >> >> >>
> >> >> >>
> >> >> >> First we need to decide on an awesome & clean theme for the
> website
> >> >> >> that
> >> >> >> will be responsive and attractive. As Bootstrap is already
> >> >> >> being
> >> used
> >> >> >> that
> >> >> >> should be no prob, but we need to use a theme that will rock.
> Please
> >> >> >> suggest themes from other sites that you find attractive and
> >> >> >> user friendly. For instance, I find the SailsJS
> >> >> >> <http://sailsjs.org/>
> >> theme
> >> >> >> very clear for reading. Also, if someone could deal with the
> >> >> >> art
> >> work
> >> >> >> that
> >> >> >> would be very useful.
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >> >
> >> >> >> > *2. We create a getting started guide, containing the
> >> >> >> > minimal
> set
> >> >> >> > of steps to get someone up and running.*
> >> >> >>
> >> >> >>
> >> >> >> >
> >> >> >> > *3. We create a detailed implementation guide that
> >> >> >> > addresses
> how
> >> >> >> > someone
> >> >> >> > would extend Shindig to build their own implementation.*
> >> >> >>
> >> >> >>
> >> >> >> Next, we need to make a map of the current structure of the
> >> >> >> web
> site
> >> >> >> and
> >> >> >> then suggest alternatives on how the new site should be
> structured.
> >> >> >> The
> >> >> >> key here is that it should be self explanatory and guide you
> >> >> >> step-by-step on how to do from the simplest to the most
> >> >> >> advanced task.
> Newcomers
> >> >> >> should
> >> >> >> feel comfortable with it so that they start with an appetite
> >> >> >> to
> learn
> >> >> >> more
> >> >> >> about this project.
> >> >> >>
> >> >> >> This part requires an initial gathering of all existing
> >> >> >> resources
> and
> >> >> >> cleansing. Everything should be relevant to the latest
> >> >> >> version of the framework. A few months ago I had created a
> >> >> >> GitHub
> project
> >> >> >> <
> https://github.com/theChefArchitect/os-examples-container-embedded>
> >> >> >> with
> >> >> >> a
> >> >> >> sample embedded container in a Spring web app written for
> >> >> >> this
> >> purpose.
> >> >> >> I've also noticed that the maintenance of the PHP version has
> >> stopped.
> >> >> >> All
> >> >> >> these cluttered resources should be gathered in one place
> initially
> >> and
> >> >> >> then decide which of them should be used as a reference for
> >> >> >> the
> new
> >> >> >> documentation.
> >> >> >>
> >> >> >>
> >> >> >> > *4. In the process of doing this we cleanup/consolidate
> >> >> >> > the
> >> Shindig
> >> >> >> > site
> >> >> >> > and the wiki.*
> >> >> >>
> >> >> >>
> >> >> >> One important thing that should be decided is where the
> >> documentation /
> >> >> >> tutorials should be hosted. At the moment the web site acts
> >> >> >> as a
> >> proxy
> >> >> >> for
> >> >> >> different documentation locations around the web and some
> hard-core
> >> >> >> tech
> >> >> >> docs live under Atlassian's Confulence site
> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's
> >> >> >> the
> >> story
> >> >> >> with that? Will the documentation be hosted under Confluence
> >> >> >> or
> >> under
> >> >> >> the
> >> >> >> web site?
> >> >> >>
> >> >> >> Overall, this task requires collaborative effort and should
> >> >> >> be
> done
> >> in
> >> >> >> baby
> >> >> >> steps. Documentation / guides are important but then there
> >> >> >> are
> >> plenty
> >> >> >> of
> >> >> >> other stuff needed to make this project gain a vibrant
> >> >> >> community -
> >> e.g.
> >> >> >> gadgets hosted on the site for tutorials and show cases, API
> >> >> >> documentation / integration, social media presence, etc.
> >> >> >>
> >> >> >> Looking forward to your responses.
> >> >> >>
> >> >> >> Cheers,
> >> >> >> Chris
> >> >> >>
> >> >> >>
> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
> rbaxter85@apache.org>
> >> >> >> wrote:
> >> >> >>
> >> >> >> > Does anyone feel especially passionate about this topic and
> want to
> >> >> >> > step up and take the lead on this?
> >> >> >> >
> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
> dbond@globalcad.com>
> >> >> >> wrote:
> >> >> >> > > Hi Ryan,
> >> >> >> > >
> >> >> >> > > This sounds like a really great start. I'm sure a clean
> >> >> >> > > and
> clear
> >> >> >> > getting started guide + detailed implementation guide that
> >> >> >> > can
> be
> >> >> >> > easily
> >> >> >> > located on the Shindig site will make a huge difference on
> >> >> >> > the take-up of this impressive framework.
> >> >> >> > >
> >> >> >> > > Kind regards,
> >> >> >> > >
> >> >> >> > > Darren
> >> >> >> > >
> >> >> >> > >
> >> >> >> >
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >> --
> >> >> >> Chris Spiliotopoulos
> >> >> >>
> >> >> >> Solutions Architect
> >> >> >>
> >> >
> >> >
> >>
> >
> >
> >
> > --
> > Chris Spiliotopoulos
> >
> > Solutions Architect
>
Re: Implementation Guide
Posted by Ryan Baxter <rb...@apache.org>.
Darren thanks for the offer, I am fine if you guys want to contibute a logo.
Take a look at the Apache branding site [1]. It would also be cool if
we had a "Powered By Apache" logo [2].
[1] http://www.apache.org/foundation/marks/pmcs.html
[2] https://www.apache.org/foundation/press/kit/#poweredby
On Thu, Oct 9, 2014 at 2:40 AM, Darren Bond <db...@globalcad.com> wrote:
> We have a good graphic designer on board and would be happy to provide a couple of designs options for the logo.
>
> As Ryan mentioned, this should be a secondary priority but we're happy to produce something.
>
> Ryan can you kindly confirm you're happy for us to proceed? Also any keywords, metaphors, colours to work with? Maybe a brief sentence, describing the essence of Shindig that you'd like translated into a logo?
>
> Kind regards,
>
> Darren
>
>
RE: Implementation Guide
Posted by Darren Bond <db...@globalcad.com>.
We have a good graphic designer on board and would be happy to provide a couple of designs options for the logo.
As Ryan mentioned, this should be a secondary priority but we're happy to produce something.
Ryan can you kindly confirm you're happy for us to proceed? Also any keywords, metaphors, colours to work with? Maybe a brief sentence, describing the essence of Shindig that you'd like translated into a logo?
Kind regards,
Darren
Re: Implementation Guide
Posted by Ryan Baxter <rb...@apache.org>.
Chris as far as the site organization goes, here are the parts of the
site I think need to stick around....
1.) Everything under the Get Shindig menu
2.) Everything under Community
3.) Documentation - Security, Website, Releasing
4.) Everything under Apache
Other sections either need major updates to them or I think might be
covered in the implementation guide.
1.) Documentation - Java, PHP, Features
2.) About Shindig - needs major updating
On Thu, Oct 9, 2014 at 2:22 AM, Chris Spiliotopoulos
<ch...@gmail.com> wrote:
> Ryan, Raj hi,
>
> thanks for the feedback. Ryan, I'm indeed in favor of the wiki, as
> Confluence is IMO a top product for technical documentation. Compared to
> the site templates it provides plenty of tools for the editing and
> presentation of the content, supports rich content and hierarchical page
> structure by default. On the other hand, writing content using markdown
> within the CMS templates is fast but can be cumbersome if you want to do
> more advanced stuff. Plus, Confluence is an OpenSocial container and
> gadgets can be included in the pages.
>
> Anyway, it's matter of personal preference. We could try both and see how
> it goes. But first things first - we should come up with a new structure
> for the web site that will help the user find his way through the resources.
>
> Cheers,
> Chris
>
> On Thu, Oct 9, 2014 at 3:14 AM, Raj Janorkar <ra...@gmail.com> wrote:
>
>> I think it is good idea. There are not many editors to the doco at this
>> moment.
>>
>> I see only you, me and chris. Dont know other people may join in future.
>>
>> So i think it is good idea to put doco on main site as long as we all can
>> make changes.
>> What do you think Chris?
>>
>>
>> On Thu, Oct 9, 2014 at 10:09 AM, Ryan Baxter <rb...@gmail.com> wrote:
>>
>> > That is my thinking, but sounded like Chris was favoring the wiki.
>> > Wanted to see what he thought.
>> >
>> > On Wed, Oct 8, 2014 at 8:05 PM, Raj Janorkar <ra...@gmail.com>
>> > wrote:
>> > > Okay.
>> > >
>> > > So Ryan do you want to put all doco on
>> > http://shindig.apache.org/index.html
>> > > ?
>> > >
>> > >
>> > >
>> > > On Thu, Oct 9, 2014 at 9:58 AM, Ryan Baxter <rb...@gmail.com>
>> wrote:
>> > >>
>> > >> The logo should not block us, its a nice to have IMO.
>> > >>
>> > >> The template shouldn't either, although if you guys want to tackle
>> > >> that I am fine.
>> > >>
>> > >> The main point I was making was that other projects are using their
>> > >> project sites to serve their documentation and not a separate wiki,
>> > >> like the confluence one.
>> > >>
>> > >> On Wed, Oct 8, 2014 at 7:52 PM, Raj Janorkar <ra...@gmail.com>
>> > >> wrote:
>> > >> > Hi Ryan,
>> > >> >
>> > >> > I think we need
>> > >> >
>> > >> > 1) Great Logo for shindig
>> > >> > 2) Attractive yet simple template for doco.
>> > >> > 3) Few shindig implementations on web, this will help users to
>> > >> > understand
>> > >> > how shindig work and what extend it can be enhanced.
>> > >> >
>> > >> > These will help shindig to attract new users/developers.
>> > >> >
>> > >> > Sorry i do not have skill to develop logo. If we dont get any i am
>> > happy
>> > >> > to
>> > >> > find some font which will look good for name "shindig", let me know.
>> > >> >
>> > >> >
>> > >> > Regards,
>> > >> > Raj
>> > >> >
>> > >> > On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org>
>> > >> > wrote:
>> > >> >
>> > >> >> Chris many other popular apache projects keep the project
>> > >> >> documentation on the project site....take a look at Apache HTTP,
>> > >> >> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
>> > >> >> over to Apache CMS or not but I would rather stick with the
>> > >> >> convention.
>> > >> >>
>> > >> >> Agree on a new logo, if anyone has the skills to come up with one
>> > that
>> > >> >> would be great.
>> > >> >>
>> > >> >> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
>> > >> >> <ch...@gmail.com> wrote:
>> > >> >> > Hi all,
>> > >> >> >
>> > >> >> > the question is how we should balance the material between Apache
>> > CMS
>> > >> >> > and
>> > >> >> > Confluence. I think that all technical guides and resources
>> should
>> > >> >> > go
>> > >> >> into
>> > >> >> > Confluence - making it the official documentation space, rather
>> > than
>> > >> >> just a
>> > >> >> > wiki - and all the high-level reference / 'marketing' / news
>> > material
>> > >> >> into
>> > >> >> > the web site.
>> > >> >> >
>> > >> >> > I'm having a look at different Bootstrap themes in order to
>> select
>> > a
>> > >> >> > few,
>> > >> >> > submit the initial list and let the people involved decide. As
>> > I've
>> > >> >> > already said, I think we should use a vibrant theme that shouts
>> > "Hey,
>> > >> >> have
>> > >> >> > a look inside. It's good stuff!" therefore my attention is
>> grabbed
>> > by
>> > >> >> > 'landing page' / 'agency' parallax type themes.
>> > >> >> >
>> > >> >> > One thing that is missing though, is a kick-ass Shindig logo. Is
>> > >> >> > someone
>> > >> >> > willing to create one? Raj, if you could suggest a Bootstrap
>> theme
>> > >> >> > that
>> > >> >> > would be great.
>> > >> >> >
>> > >> >> > In the following days, I'll post a selection of themes as a
>> > reference
>> > >> >> > and
>> > >> >> > we can vote. Also, I'll try and write down a suggested link
>> > >> >> > structure
>> > >> >> for
>> > >> >> > the new site and also a scaffolding for the technical docs in
>> > >> >> > Confluence.
>> > >> >> >
>> > >> >> > Let me know what you think.
>> > >> >> >
>> > >> >> > Cheers,
>> > >> >> > Chris
>> > >> >> >
>> > >> >> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <
>> rbaxter85@apache.org>
>> > >> >> wrote:
>> > >> >> >
>> > >> >> >> OK well for reference check out the website docs [1]. Let me
>> know
>> > >> >> >> if
>> > >> >> >> you have any problems.
>> > >> >> >>
>> > >> >> >> [1] http://shindig.apache.org/documentation_website.html
>> > >> >> >>
>> > >> >> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar
>> > >> >> >> <ra...@gmail.com>
>> > >> >> >> wrote:
>> > >> >> >> > Hi Ryan,
>> > >> >> >> >
>> > >> >> >> > In my work place i am using Confluence. so i don't think there
>> > >> >> >> > will be
>> > >> >> >> > problem to me.
>> > >> >> >> >
>> > >> >> >> > Regards,
>> > >> >> >> > Raj
>> > >> >> >> >
>> > >> >> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <
>> > rbaxter85@gmail.com>
>> > >> >> wrote:
>> > >> >> >> >>
>> > >> >> >> >> Chris and Raj, appreciate you both stepping up! Are you
>> > familiar
>> > >> >> with
>> > >> >> >> >> how to use Apache CMS to edit the Shindig site?
>> > >> >> >> >>
>> > >> >> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar
>> > >> >> >> >> <raj.janorkar@gmail.com
>> > >> >> >
>> > >> >> >> >> wrote:
>> > >> >> >> >> > I am also in.
>> > >> >> >> >> > though i am new here but ready to help wherever i can.
>> > >> >> >> >> >
>> > >> >> >> >> > Thank you for this great step.
>> > >> >> >> >> >
>> > >> >> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
>> > >> >> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
>> > >> >> >> >> >
>> > >> >> >> >> >> Hi all,
>> > >> >> >> >> >>
>> > >> >> >> >> >> I am willing to take the first step forward on this but I
>> > >> >> >> >> >> expect
>> > >> >> all
>> > >> >> >> >> >> the
>> > >> >> >> >> >> people in this group to contribute / suggest / vote on
>> > >> >> >> >> >> important
>> > >> >> >> things
>> > >> >> >> >> >> that will make the Shindig project come back to life and
>> > start
>> > >> >> >> >> >> receiving
>> > >> >> >> >> >> attention. Based on the steps that Ryan suggested:
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> > *1. We use the Shindig site as the place to keep the
>> > >> >> >> documentation.
>> > >> >> >> >> >> > It
>> > >> >> >> >> >> is
>> > >> >> >> >> >> > CMS based [1] so no need to know how to write HTML.*
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> First we need to decide on an awesome & clean theme for
>> the
>> > >> >> website
>> > >> >> >> >> >> that
>> > >> >> >> >> >> will be responsive and attractive. As Bootstrap is
>> already
>> > >> >> >> >> >> being
>> > >> >> >> used
>> > >> >> >> >> >> that
>> > >> >> >> >> >> should be no prob, but we need to use a theme that will
>> > rock.
>> > >> >> Please
>> > >> >> >> >> >> suggest themes from other sites that you find attractive
>> and
>> > >> >> >> >> >> user
>> > >> >> >> >> >> friendly. For instance, I find the SailsJS
>> > >> >> >> >> >> <http://sailsjs.org/>
>> > >> >> >> theme
>> > >> >> >> >> >> very clear for reading. Also, if someone could deal with
>> > the
>> > >> >> >> >> >> art
>> > >> >> >> work
>> > >> >> >> >> >> that
>> > >> >> >> >> >> would be very useful.
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> >
>> > >> >> >> >> >> > *2. We create a getting started guide, containing the
>> > >> >> >> >> >> > minimal
>> > >> >> set
>> > >> >> >> >> >> > of steps to get someone up and running.*
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> >
>> > >> >> >> >> >> > *3. We create a detailed implementation guide that
>> > >> >> >> >> >> > addresses
>> > >> >> how
>> > >> >> >> >> >> > someone
>> > >> >> >> >> >> > would extend Shindig to build their own implementation.*
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> Next, we need to make a map of the current structure of
>> the
>> > >> >> >> >> >> web
>> > >> >> site
>> > >> >> >> >> >> and
>> > >> >> >> >> >> then suggest alternatives on how the new site should be
>> > >> >> structured.
>> > >> >> >> >> >> The
>> > >> >> >> >> >> key here is that it should be self explanatory and guide
>> you
>> > >> >> >> >> >> step-by-step
>> > >> >> >> >> >> on how to do from the simplest to the most advanced task.
>> > >> >> Newcomers
>> > >> >> >> >> >> should
>> > >> >> >> >> >> feel comfortable with it so that they start with an
>> appetite
>> > >> >> >> >> >> to
>> > >> >> learn
>> > >> >> >> >> >> more
>> > >> >> >> >> >> about this project.
>> > >> >> >> >> >>
>> > >> >> >> >> >> This part requires an initial gathering of all existing
>> > >> >> >> >> >> resources
>> > >> >> and
>> > >> >> >> >> >> cleansing. Everything should be relevant to the latest
>> > >> >> >> >> >> version
>> > >> >> >> >> >> of the framework. A few months ago I had created a
>> GitHub
>> > >> >> project
>> > >> >> >> >> >> <
>> > >> >> https://github.com/theChefArchitect/os-examples-container-embedded
>> >
>> > >> >> >> >> >> with
>> > >> >> >> >> >> a
>> > >> >> >> >> >> sample embedded container in a Spring web app written for
>> > this
>> > >> >> >> purpose.
>> > >> >> >> >> >> I've also noticed that the maintenance of the PHP version
>> > has
>> > >> >> >> stopped.
>> > >> >> >> >> >> All
>> > >> >> >> >> >> these cluttered resources should be gathered in one place
>> > >> >> initially
>> > >> >> >> and
>> > >> >> >> >> >> then decide which of them should be used as a reference
>> for
>> > >> >> >> >> >> the
>> > >> >> new
>> > >> >> >> >> >> documentation.
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> > *4. In the process of doing this we cleanup/consolidate
>> > the
>> > >> >> >> Shindig
>> > >> >> >> >> >> > site
>> > >> >> >> >> >> > and the wiki.*
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> One important thing that should be decided is where the
>> > >> >> >> documentation /
>> > >> >> >> >> >> tutorials should be hosted. At the moment the web site
>> acts
>> > >> >> >> >> >> as a
>> > >> >> >> proxy
>> > >> >> >> >> >> for
>> > >> >> >> >> >> different documentation locations around the web and some
>> > >> >> hard-core
>> > >> >> >> >> >> tech
>> > >> >> >> >> >> docs live under Atlassian's Confulence site
>> > >> >> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>.
>> > What's
>> > >> >> >> >> >> the
>> > >> >> >> story
>> > >> >> >> >> >> with that? Will the documentation be hosted under
>> > Confluence
>> > >> >> >> >> >> or
>> > >> >> >> under
>> > >> >> >> >> >> the
>> > >> >> >> >> >> web site?
>> > >> >> >> >> >>
>> > >> >> >> >> >> Overall, this task requires collaborative effort and
>> should
>> > be
>> > >> >> done
>> > >> >> >> in
>> > >> >> >> >> >> baby
>> > >> >> >> >> >> steps. Documentation / guides are important but then
>> there
>> > >> >> >> >> >> are
>> > >> >> >> plenty
>> > >> >> >> >> >> of
>> > >> >> >> >> >> other stuff needed to make this project gain a vibrant
>> > >> >> >> >> >> community -
>> > >> >> >> e.g.
>> > >> >> >> >> >> gadgets hosted on the site for tutorials and show cases,
>> API
>> > >> >> >> >> >> documentation
>> > >> >> >> >> >> / integration, social media presence, etc.
>> > >> >> >> >> >>
>> > >> >> >> >> >> Looking forward to your responses.
>> > >> >> >> >> >>
>> > >> >> >> >> >> Cheers,
>> > >> >> >> >> >> Chris
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
>> > >> >> rbaxter85@apache.org>
>> > >> >> >> >> >> wrote:
>> > >> >> >> >> >>
>> > >> >> >> >> >> > Does anyone feel especially passionate about this topic
>> > and
>> > >> >> want to
>> > >> >> >> >> >> > step up and take the lead on this?
>> > >> >> >> >> >> >
>> > >> >> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
>> > >> >> dbond@globalcad.com>
>> > >> >> >> >> >> wrote:
>> > >> >> >> >> >> > > Hi Ryan,
>> > >> >> >> >> >> > >
>> > >> >> >> >> >> > > This sounds like a really great start. I'm sure a
>> clean
>> > >> >> >> >> >> > > and
>> > >> >> clear
>> > >> >> >> >> >> > getting started guide + detailed implementation guide
>> that
>> > >> >> >> >> >> > can
>> > >> >> be
>> > >> >> >> >> >> > easily
>> > >> >> >> >> >> > located on the Shindig site will make a huge difference
>> on
>> > >> >> >> >> >> > the
>> > >> >> >> >> >> > take-up of
>> > >> >> >> >> >> > this impressive framework.
>> > >> >> >> >> >> > >
>> > >> >> >> >> >> > > Kind regards,
>> > >> >> >> >> >> > >
>> > >> >> >> >> >> > > Darren
>> > >> >> >> >> >> > >
>> > >> >> >> >> >> > >
>> > >> >> >> >> >> >
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >>
>> > >> >> >> >> >> --
>> > >> >> >> >> >> Chris Spiliotopoulos
>> > >> >> >> >> >>
>> > >> >> >> >> >> Solutions Architect
>> > >> >> >> >> >>
>> > >> >> >> >
>> > >> >> >> >
>> > >> >> >>
>> > >> >> >
>> > >> >> >
>> > >> >> >
>> > >> >> > --
>> > >> >> > Chris Spiliotopoulos
>> > >> >> >
>> > >> >> > Solutions Architect
>> > >> >>
>> > >
>> > >
>> >
>>
>
>
>
> --
> Chris Spiliotopoulos
>
> Solutions Architect
Re: Implementation Guide
Posted by Chris Spiliotopoulos <ch...@gmail.com>.
Ryan, Raj hi,
thanks for the feedback. Ryan, I'm indeed in favor of the wiki, as
Confluence is IMO a top product for technical documentation. Compared to
the site templates it provides plenty of tools for the editing and
presentation of the content, supports rich content and hierarchical page
structure by default. On the other hand, writing content using markdown
within the CMS templates is fast but can be cumbersome if you want to do
more advanced stuff. Plus, Confluence is an OpenSocial container and
gadgets can be included in the pages.
Anyway, it's matter of personal preference. We could try both and see how
it goes. But first things first - we should come up with a new structure
for the web site that will help the user find his way through the resources.
Cheers,
Chris
On Thu, Oct 9, 2014 at 3:14 AM, Raj Janorkar <ra...@gmail.com> wrote:
> I think it is good idea. There are not many editors to the doco at this
> moment.
>
> I see only you, me and chris. Dont know other people may join in future.
>
> So i think it is good idea to put doco on main site as long as we all can
> make changes.
> What do you think Chris?
>
>
> On Thu, Oct 9, 2014 at 10:09 AM, Ryan Baxter <rb...@gmail.com> wrote:
>
> > That is my thinking, but sounded like Chris was favoring the wiki.
> > Wanted to see what he thought.
> >
> > On Wed, Oct 8, 2014 at 8:05 PM, Raj Janorkar <ra...@gmail.com>
> > wrote:
> > > Okay.
> > >
> > > So Ryan do you want to put all doco on
> > http://shindig.apache.org/index.html
> > > ?
> > >
> > >
> > >
> > > On Thu, Oct 9, 2014 at 9:58 AM, Ryan Baxter <rb...@gmail.com>
> wrote:
> > >>
> > >> The logo should not block us, its a nice to have IMO.
> > >>
> > >> The template shouldn't either, although if you guys want to tackle
> > >> that I am fine.
> > >>
> > >> The main point I was making was that other projects are using their
> > >> project sites to serve their documentation and not a separate wiki,
> > >> like the confluence one.
> > >>
> > >> On Wed, Oct 8, 2014 at 7:52 PM, Raj Janorkar <ra...@gmail.com>
> > >> wrote:
> > >> > Hi Ryan,
> > >> >
> > >> > I think we need
> > >> >
> > >> > 1) Great Logo for shindig
> > >> > 2) Attractive yet simple template for doco.
> > >> > 3) Few shindig implementations on web, this will help users to
> > >> > understand
> > >> > how shindig work and what extend it can be enhanced.
> > >> >
> > >> > These will help shindig to attract new users/developers.
> > >> >
> > >> > Sorry i do not have skill to develop logo. If we dont get any i am
> > happy
> > >> > to
> > >> > find some font which will look good for name "shindig", let me know.
> > >> >
> > >> >
> > >> > Regards,
> > >> > Raj
> > >> >
> > >> > On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org>
> > >> > wrote:
> > >> >
> > >> >> Chris many other popular apache projects keep the project
> > >> >> documentation on the project site....take a look at Apache HTTP,
> > >> >> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
> > >> >> over to Apache CMS or not but I would rather stick with the
> > >> >> convention.
> > >> >>
> > >> >> Agree on a new logo, if anyone has the skills to come up with one
> > that
> > >> >> would be great.
> > >> >>
> > >> >> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
> > >> >> <ch...@gmail.com> wrote:
> > >> >> > Hi all,
> > >> >> >
> > >> >> > the question is how we should balance the material between Apache
> > CMS
> > >> >> > and
> > >> >> > Confluence. I think that all technical guides and resources
> should
> > >> >> > go
> > >> >> into
> > >> >> > Confluence - making it the official documentation space, rather
> > than
> > >> >> just a
> > >> >> > wiki - and all the high-level reference / 'marketing' / news
> > material
> > >> >> into
> > >> >> > the web site.
> > >> >> >
> > >> >> > I'm having a look at different Bootstrap themes in order to
> select
> > a
> > >> >> > few,
> > >> >> > submit the initial list and let the people involved decide. As
> > I've
> > >> >> > already said, I think we should use a vibrant theme that shouts
> > "Hey,
> > >> >> have
> > >> >> > a look inside. It's good stuff!" therefore my attention is
> grabbed
> > by
> > >> >> > 'landing page' / 'agency' parallax type themes.
> > >> >> >
> > >> >> > One thing that is missing though, is a kick-ass Shindig logo. Is
> > >> >> > someone
> > >> >> > willing to create one? Raj, if you could suggest a Bootstrap
> theme
> > >> >> > that
> > >> >> > would be great.
> > >> >> >
> > >> >> > In the following days, I'll post a selection of themes as a
> > reference
> > >> >> > and
> > >> >> > we can vote. Also, I'll try and write down a suggested link
> > >> >> > structure
> > >> >> for
> > >> >> > the new site and also a scaffolding for the technical docs in
> > >> >> > Confluence.
> > >> >> >
> > >> >> > Let me know what you think.
> > >> >> >
> > >> >> > Cheers,
> > >> >> > Chris
> > >> >> >
> > >> >> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <
> rbaxter85@apache.org>
> > >> >> wrote:
> > >> >> >
> > >> >> >> OK well for reference check out the website docs [1]. Let me
> know
> > >> >> >> if
> > >> >> >> you have any problems.
> > >> >> >>
> > >> >> >> [1] http://shindig.apache.org/documentation_website.html
> > >> >> >>
> > >> >> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar
> > >> >> >> <ra...@gmail.com>
> > >> >> >> wrote:
> > >> >> >> > Hi Ryan,
> > >> >> >> >
> > >> >> >> > In my work place i am using Confluence. so i don't think there
> > >> >> >> > will be
> > >> >> >> > problem to me.
> > >> >> >> >
> > >> >> >> > Regards,
> > >> >> >> > Raj
> > >> >> >> >
> > >> >> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <
> > rbaxter85@gmail.com>
> > >> >> wrote:
> > >> >> >> >>
> > >> >> >> >> Chris and Raj, appreciate you both stepping up! Are you
> > familiar
> > >> >> with
> > >> >> >> >> how to use Apache CMS to edit the Shindig site?
> > >> >> >> >>
> > >> >> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar
> > >> >> >> >> <raj.janorkar@gmail.com
> > >> >> >
> > >> >> >> >> wrote:
> > >> >> >> >> > I am also in.
> > >> >> >> >> > though i am new here but ready to help wherever i can.
> > >> >> >> >> >
> > >> >> >> >> > Thank you for this great step.
> > >> >> >> >> >
> > >> >> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> > >> >> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> > >> >> >> >> >
> > >> >> >> >> >> Hi all,
> > >> >> >> >> >>
> > >> >> >> >> >> I am willing to take the first step forward on this but I
> > >> >> >> >> >> expect
> > >> >> all
> > >> >> >> >> >> the
> > >> >> >> >> >> people in this group to contribute / suggest / vote on
> > >> >> >> >> >> important
> > >> >> >> things
> > >> >> >> >> >> that will make the Shindig project come back to life and
> > start
> > >> >> >> >> >> receiving
> > >> >> >> >> >> attention. Based on the steps that Ryan suggested:
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> > *1. We use the Shindig site as the place to keep the
> > >> >> >> documentation.
> > >> >> >> >> >> > It
> > >> >> >> >> >> is
> > >> >> >> >> >> > CMS based [1] so no need to know how to write HTML.*
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> First we need to decide on an awesome & clean theme for
> the
> > >> >> website
> > >> >> >> >> >> that
> > >> >> >> >> >> will be responsive and attractive. As Bootstrap is
> already
> > >> >> >> >> >> being
> > >> >> >> used
> > >> >> >> >> >> that
> > >> >> >> >> >> should be no prob, but we need to use a theme that will
> > rock.
> > >> >> Please
> > >> >> >> >> >> suggest themes from other sites that you find attractive
> and
> > >> >> >> >> >> user
> > >> >> >> >> >> friendly. For instance, I find the SailsJS
> > >> >> >> >> >> <http://sailsjs.org/>
> > >> >> >> theme
> > >> >> >> >> >> very clear for reading. Also, if someone could deal with
> > the
> > >> >> >> >> >> art
> > >> >> >> work
> > >> >> >> >> >> that
> > >> >> >> >> >> would be very useful.
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> >
> > >> >> >> >> >> > *2. We create a getting started guide, containing the
> > >> >> >> >> >> > minimal
> > >> >> set
> > >> >> >> >> >> > of steps to get someone up and running.*
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> >
> > >> >> >> >> >> > *3. We create a detailed implementation guide that
> > >> >> >> >> >> > addresses
> > >> >> how
> > >> >> >> >> >> > someone
> > >> >> >> >> >> > would extend Shindig to build their own implementation.*
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> Next, we need to make a map of the current structure of
> the
> > >> >> >> >> >> web
> > >> >> site
> > >> >> >> >> >> and
> > >> >> >> >> >> then suggest alternatives on how the new site should be
> > >> >> structured.
> > >> >> >> >> >> The
> > >> >> >> >> >> key here is that it should be self explanatory and guide
> you
> > >> >> >> >> >> step-by-step
> > >> >> >> >> >> on how to do from the simplest to the most advanced task.
> > >> >> Newcomers
> > >> >> >> >> >> should
> > >> >> >> >> >> feel comfortable with it so that they start with an
> appetite
> > >> >> >> >> >> to
> > >> >> learn
> > >> >> >> >> >> more
> > >> >> >> >> >> about this project.
> > >> >> >> >> >>
> > >> >> >> >> >> This part requires an initial gathering of all existing
> > >> >> >> >> >> resources
> > >> >> and
> > >> >> >> >> >> cleansing. Everything should be relevant to the latest
> > >> >> >> >> >> version
> > >> >> >> >> >> of the framework. A few months ago I had created a
> GitHub
> > >> >> project
> > >> >> >> >> >> <
> > >> >> https://github.com/theChefArchitect/os-examples-container-embedded
> >
> > >> >> >> >> >> with
> > >> >> >> >> >> a
> > >> >> >> >> >> sample embedded container in a Spring web app written for
> > this
> > >> >> >> purpose.
> > >> >> >> >> >> I've also noticed that the maintenance of the PHP version
> > has
> > >> >> >> stopped.
> > >> >> >> >> >> All
> > >> >> >> >> >> these cluttered resources should be gathered in one place
> > >> >> initially
> > >> >> >> and
> > >> >> >> >> >> then decide which of them should be used as a reference
> for
> > >> >> >> >> >> the
> > >> >> new
> > >> >> >> >> >> documentation.
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> > *4. In the process of doing this we cleanup/consolidate
> > the
> > >> >> >> Shindig
> > >> >> >> >> >> > site
> > >> >> >> >> >> > and the wiki.*
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> One important thing that should be decided is where the
> > >> >> >> documentation /
> > >> >> >> >> >> tutorials should be hosted. At the moment the web site
> acts
> > >> >> >> >> >> as a
> > >> >> >> proxy
> > >> >> >> >> >> for
> > >> >> >> >> >> different documentation locations around the web and some
> > >> >> hard-core
> > >> >> >> >> >> tech
> > >> >> >> >> >> docs live under Atlassian's Confulence site
> > >> >> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>.
> > What's
> > >> >> >> >> >> the
> > >> >> >> story
> > >> >> >> >> >> with that? Will the documentation be hosted under
> > Confluence
> > >> >> >> >> >> or
> > >> >> >> under
> > >> >> >> >> >> the
> > >> >> >> >> >> web site?
> > >> >> >> >> >>
> > >> >> >> >> >> Overall, this task requires collaborative effort and
> should
> > be
> > >> >> done
> > >> >> >> in
> > >> >> >> >> >> baby
> > >> >> >> >> >> steps. Documentation / guides are important but then
> there
> > >> >> >> >> >> are
> > >> >> >> plenty
> > >> >> >> >> >> of
> > >> >> >> >> >> other stuff needed to make this project gain a vibrant
> > >> >> >> >> >> community -
> > >> >> >> e.g.
> > >> >> >> >> >> gadgets hosted on the site for tutorials and show cases,
> API
> > >> >> >> >> >> documentation
> > >> >> >> >> >> / integration, social media presence, etc.
> > >> >> >> >> >>
> > >> >> >> >> >> Looking forward to your responses.
> > >> >> >> >> >>
> > >> >> >> >> >> Cheers,
> > >> >> >> >> >> Chris
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
> > >> >> rbaxter85@apache.org>
> > >> >> >> >> >> wrote:
> > >> >> >> >> >>
> > >> >> >> >> >> > Does anyone feel especially passionate about this topic
> > and
> > >> >> want to
> > >> >> >> >> >> > step up and take the lead on this?
> > >> >> >> >> >> >
> > >> >> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
> > >> >> dbond@globalcad.com>
> > >> >> >> >> >> wrote:
> > >> >> >> >> >> > > Hi Ryan,
> > >> >> >> >> >> > >
> > >> >> >> >> >> > > This sounds like a really great start. I'm sure a
> clean
> > >> >> >> >> >> > > and
> > >> >> clear
> > >> >> >> >> >> > getting started guide + detailed implementation guide
> that
> > >> >> >> >> >> > can
> > >> >> be
> > >> >> >> >> >> > easily
> > >> >> >> >> >> > located on the Shindig site will make a huge difference
> on
> > >> >> >> >> >> > the
> > >> >> >> >> >> > take-up of
> > >> >> >> >> >> > this impressive framework.
> > >> >> >> >> >> > >
> > >> >> >> >> >> > > Kind regards,
> > >> >> >> >> >> > >
> > >> >> >> >> >> > > Darren
> > >> >> >> >> >> > >
> > >> >> >> >> >> > >
> > >> >> >> >> >> >
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >>
> > >> >> >> >> >> --
> > >> >> >> >> >> Chris Spiliotopoulos
> > >> >> >> >> >>
> > >> >> >> >> >> Solutions Architect
> > >> >> >> >> >>
> > >> >> >> >
> > >> >> >> >
> > >> >> >>
> > >> >> >
> > >> >> >
> > >> >> >
> > >> >> > --
> > >> >> > Chris Spiliotopoulos
> > >> >> >
> > >> >> > Solutions Architect
> > >> >>
> > >
> > >
> >
>
--
Chris Spiliotopoulos
Solutions Architect
Re: Implementation Guide
Posted by Raj Janorkar <ra...@gmail.com>.
I think it is good idea. There are not many editors to the doco at this
moment.
I see only you, me and chris. Dont know other people may join in future.
So i think it is good idea to put doco on main site as long as we all can
make changes.
What do you think Chris?
On Thu, Oct 9, 2014 at 10:09 AM, Ryan Baxter <rb...@gmail.com> wrote:
> That is my thinking, but sounded like Chris was favoring the wiki.
> Wanted to see what he thought.
>
> On Wed, Oct 8, 2014 at 8:05 PM, Raj Janorkar <ra...@gmail.com>
> wrote:
> > Okay.
> >
> > So Ryan do you want to put all doco on
> http://shindig.apache.org/index.html
> > ?
> >
> >
> >
> > On Thu, Oct 9, 2014 at 9:58 AM, Ryan Baxter <rb...@gmail.com> wrote:
> >>
> >> The logo should not block us, its a nice to have IMO.
> >>
> >> The template shouldn't either, although if you guys want to tackle
> >> that I am fine.
> >>
> >> The main point I was making was that other projects are using their
> >> project sites to serve their documentation and not a separate wiki,
> >> like the confluence one.
> >>
> >> On Wed, Oct 8, 2014 at 7:52 PM, Raj Janorkar <ra...@gmail.com>
> >> wrote:
> >> > Hi Ryan,
> >> >
> >> > I think we need
> >> >
> >> > 1) Great Logo for shindig
> >> > 2) Attractive yet simple template for doco.
> >> > 3) Few shindig implementations on web, this will help users to
> >> > understand
> >> > how shindig work and what extend it can be enhanced.
> >> >
> >> > These will help shindig to attract new users/developers.
> >> >
> >> > Sorry i do not have skill to develop logo. If we dont get any i am
> happy
> >> > to
> >> > find some font which will look good for name "shindig", let me know.
> >> >
> >> >
> >> > Regards,
> >> > Raj
> >> >
> >> > On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org>
> >> > wrote:
> >> >
> >> >> Chris many other popular apache projects keep the project
> >> >> documentation on the project site....take a look at Apache HTTP,
> >> >> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
> >> >> over to Apache CMS or not but I would rather stick with the
> >> >> convention.
> >> >>
> >> >> Agree on a new logo, if anyone has the skills to come up with one
> that
> >> >> would be great.
> >> >>
> >> >> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
> >> >> <ch...@gmail.com> wrote:
> >> >> > Hi all,
> >> >> >
> >> >> > the question is how we should balance the material between Apache
> CMS
> >> >> > and
> >> >> > Confluence. I think that all technical guides and resources should
> >> >> > go
> >> >> into
> >> >> > Confluence - making it the official documentation space, rather
> than
> >> >> just a
> >> >> > wiki - and all the high-level reference / 'marketing' / news
> material
> >> >> into
> >> >> > the web site.
> >> >> >
> >> >> > I'm having a look at different Bootstrap themes in order to select
> a
> >> >> > few,
> >> >> > submit the initial list and let the people involved decide. As
> I've
> >> >> > already said, I think we should use a vibrant theme that shouts
> "Hey,
> >> >> have
> >> >> > a look inside. It's good stuff!" therefore my attention is grabbed
> by
> >> >> > 'landing page' / 'agency' parallax type themes.
> >> >> >
> >> >> > One thing that is missing though, is a kick-ass Shindig logo. Is
> >> >> > someone
> >> >> > willing to create one? Raj, if you could suggest a Bootstrap theme
> >> >> > that
> >> >> > would be great.
> >> >> >
> >> >> > In the following days, I'll post a selection of themes as a
> reference
> >> >> > and
> >> >> > we can vote. Also, I'll try and write down a suggested link
> >> >> > structure
> >> >> for
> >> >> > the new site and also a scaffolding for the technical docs in
> >> >> > Confluence.
> >> >> >
> >> >> > Let me know what you think.
> >> >> >
> >> >> > Cheers,
> >> >> > Chris
> >> >> >
> >> >> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
> >> >> wrote:
> >> >> >
> >> >> >> OK well for reference check out the website docs [1]. Let me know
> >> >> >> if
> >> >> >> you have any problems.
> >> >> >>
> >> >> >> [1] http://shindig.apache.org/documentation_website.html
> >> >> >>
> >> >> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar
> >> >> >> <ra...@gmail.com>
> >> >> >> wrote:
> >> >> >> > Hi Ryan,
> >> >> >> >
> >> >> >> > In my work place i am using Confluence. so i don't think there
> >> >> >> > will be
> >> >> >> > problem to me.
> >> >> >> >
> >> >> >> > Regards,
> >> >> >> > Raj
> >> >> >> >
> >> >> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <
> rbaxter85@gmail.com>
> >> >> wrote:
> >> >> >> >>
> >> >> >> >> Chris and Raj, appreciate you both stepping up! Are you
> familiar
> >> >> with
> >> >> >> >> how to use Apache CMS to edit the Shindig site?
> >> >> >> >>
> >> >> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar
> >> >> >> >> <raj.janorkar@gmail.com
> >> >> >
> >> >> >> >> wrote:
> >> >> >> >> > I am also in.
> >> >> >> >> > though i am new here but ready to help wherever i can.
> >> >> >> >> >
> >> >> >> >> > Thank you for this great step.
> >> >> >> >> >
> >> >> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> >> >> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >> >> >> >> >
> >> >> >> >> >> Hi all,
> >> >> >> >> >>
> >> >> >> >> >> I am willing to take the first step forward on this but I
> >> >> >> >> >> expect
> >> >> all
> >> >> >> >> >> the
> >> >> >> >> >> people in this group to contribute / suggest / vote on
> >> >> >> >> >> important
> >> >> >> things
> >> >> >> >> >> that will make the Shindig project come back to life and
> start
> >> >> >> >> >> receiving
> >> >> >> >> >> attention. Based on the steps that Ryan suggested:
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> > *1. We use the Shindig site as the place to keep the
> >> >> >> documentation.
> >> >> >> >> >> > It
> >> >> >> >> >> is
> >> >> >> >> >> > CMS based [1] so no need to know how to write HTML.*
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> First we need to decide on an awesome & clean theme for the
> >> >> website
> >> >> >> >> >> that
> >> >> >> >> >> will be responsive and attractive. As Bootstrap is already
> >> >> >> >> >> being
> >> >> >> used
> >> >> >> >> >> that
> >> >> >> >> >> should be no prob, but we need to use a theme that will
> rock.
> >> >> Please
> >> >> >> >> >> suggest themes from other sites that you find attractive and
> >> >> >> >> >> user
> >> >> >> >> >> friendly. For instance, I find the SailsJS
> >> >> >> >> >> <http://sailsjs.org/>
> >> >> >> theme
> >> >> >> >> >> very clear for reading. Also, if someone could deal with
> the
> >> >> >> >> >> art
> >> >> >> work
> >> >> >> >> >> that
> >> >> >> >> >> would be very useful.
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> >
> >> >> >> >> >> > *2. We create a getting started guide, containing the
> >> >> >> >> >> > minimal
> >> >> set
> >> >> >> >> >> > of steps to get someone up and running.*
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> >
> >> >> >> >> >> > *3. We create a detailed implementation guide that
> >> >> >> >> >> > addresses
> >> >> how
> >> >> >> >> >> > someone
> >> >> >> >> >> > would extend Shindig to build their own implementation.*
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> Next, we need to make a map of the current structure of the
> >> >> >> >> >> web
> >> >> site
> >> >> >> >> >> and
> >> >> >> >> >> then suggest alternatives on how the new site should be
> >> >> structured.
> >> >> >> >> >> The
> >> >> >> >> >> key here is that it should be self explanatory and guide you
> >> >> >> >> >> step-by-step
> >> >> >> >> >> on how to do from the simplest to the most advanced task.
> >> >> Newcomers
> >> >> >> >> >> should
> >> >> >> >> >> feel comfortable with it so that they start with an appetite
> >> >> >> >> >> to
> >> >> learn
> >> >> >> >> >> more
> >> >> >> >> >> about this project.
> >> >> >> >> >>
> >> >> >> >> >> This part requires an initial gathering of all existing
> >> >> >> >> >> resources
> >> >> and
> >> >> >> >> >> cleansing. Everything should be relevant to the latest
> >> >> >> >> >> version
> >> >> >> >> >> of the framework. A few months ago I had created a GitHub
> >> >> project
> >> >> >> >> >> <
> >> >> https://github.com/theChefArchitect/os-examples-container-embedded>
> >> >> >> >> >> with
> >> >> >> >> >> a
> >> >> >> >> >> sample embedded container in a Spring web app written for
> this
> >> >> >> purpose.
> >> >> >> >> >> I've also noticed that the maintenance of the PHP version
> has
> >> >> >> stopped.
> >> >> >> >> >> All
> >> >> >> >> >> these cluttered resources should be gathered in one place
> >> >> initially
> >> >> >> and
> >> >> >> >> >> then decide which of them should be used as a reference for
> >> >> >> >> >> the
> >> >> new
> >> >> >> >> >> documentation.
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> > *4. In the process of doing this we cleanup/consolidate
> the
> >> >> >> Shindig
> >> >> >> >> >> > site
> >> >> >> >> >> > and the wiki.*
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> One important thing that should be decided is where the
> >> >> >> documentation /
> >> >> >> >> >> tutorials should be hosted. At the moment the web site acts
> >> >> >> >> >> as a
> >> >> >> proxy
> >> >> >> >> >> for
> >> >> >> >> >> different documentation locations around the web and some
> >> >> hard-core
> >> >> >> >> >> tech
> >> >> >> >> >> docs live under Atlassian's Confulence site
> >> >> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>.
> What's
> >> >> >> >> >> the
> >> >> >> story
> >> >> >> >> >> with that? Will the documentation be hosted under
> Confluence
> >> >> >> >> >> or
> >> >> >> under
> >> >> >> >> >> the
> >> >> >> >> >> web site?
> >> >> >> >> >>
> >> >> >> >> >> Overall, this task requires collaborative effort and should
> be
> >> >> done
> >> >> >> in
> >> >> >> >> >> baby
> >> >> >> >> >> steps. Documentation / guides are important but then there
> >> >> >> >> >> are
> >> >> >> plenty
> >> >> >> >> >> of
> >> >> >> >> >> other stuff needed to make this project gain a vibrant
> >> >> >> >> >> community -
> >> >> >> e.g.
> >> >> >> >> >> gadgets hosted on the site for tutorials and show cases, API
> >> >> >> >> >> documentation
> >> >> >> >> >> / integration, social media presence, etc.
> >> >> >> >> >>
> >> >> >> >> >> Looking forward to your responses.
> >> >> >> >> >>
> >> >> >> >> >> Cheers,
> >> >> >> >> >> Chris
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
> >> >> rbaxter85@apache.org>
> >> >> >> >> >> wrote:
> >> >> >> >> >>
> >> >> >> >> >> > Does anyone feel especially passionate about this topic
> and
> >> >> want to
> >> >> >> >> >> > step up and take the lead on this?
> >> >> >> >> >> >
> >> >> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
> >> >> dbond@globalcad.com>
> >> >> >> >> >> wrote:
> >> >> >> >> >> > > Hi Ryan,
> >> >> >> >> >> > >
> >> >> >> >> >> > > This sounds like a really great start. I'm sure a clean
> >> >> >> >> >> > > and
> >> >> clear
> >> >> >> >> >> > getting started guide + detailed implementation guide that
> >> >> >> >> >> > can
> >> >> be
> >> >> >> >> >> > easily
> >> >> >> >> >> > located on the Shindig site will make a huge difference on
> >> >> >> >> >> > the
> >> >> >> >> >> > take-up of
> >> >> >> >> >> > this impressive framework.
> >> >> >> >> >> > >
> >> >> >> >> >> > > Kind regards,
> >> >> >> >> >> > >
> >> >> >> >> >> > > Darren
> >> >> >> >> >> > >
> >> >> >> >> >> > >
> >> >> >> >> >> >
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >>
> >> >> >> >> >> --
> >> >> >> >> >> Chris Spiliotopoulos
> >> >> >> >> >>
> >> >> >> >> >> Solutions Architect
> >> >> >> >> >>
> >> >> >> >
> >> >> >> >
> >> >> >>
> >> >> >
> >> >> >
> >> >> >
> >> >> > --
> >> >> > Chris Spiliotopoulos
> >> >> >
> >> >> > Solutions Architect
> >> >>
> >
> >
>
Re: Implementation Guide
Posted by Ryan Baxter <rb...@gmail.com>.
That is my thinking, but sounded like Chris was favoring the wiki.
Wanted to see what he thought.
On Wed, Oct 8, 2014 at 8:05 PM, Raj Janorkar <ra...@gmail.com> wrote:
> Okay.
>
> So Ryan do you want to put all doco on http://shindig.apache.org/index.html
> ?
>
>
>
> On Thu, Oct 9, 2014 at 9:58 AM, Ryan Baxter <rb...@gmail.com> wrote:
>>
>> The logo should not block us, its a nice to have IMO.
>>
>> The template shouldn't either, although if you guys want to tackle
>> that I am fine.
>>
>> The main point I was making was that other projects are using their
>> project sites to serve their documentation and not a separate wiki,
>> like the confluence one.
>>
>> On Wed, Oct 8, 2014 at 7:52 PM, Raj Janorkar <ra...@gmail.com>
>> wrote:
>> > Hi Ryan,
>> >
>> > I think we need
>> >
>> > 1) Great Logo for shindig
>> > 2) Attractive yet simple template for doco.
>> > 3) Few shindig implementations on web, this will help users to
>> > understand
>> > how shindig work and what extend it can be enhanced.
>> >
>> > These will help shindig to attract new users/developers.
>> >
>> > Sorry i do not have skill to develop logo. If we dont get any i am happy
>> > to
>> > find some font which will look good for name "shindig", let me know.
>> >
>> >
>> > Regards,
>> > Raj
>> >
>> > On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org>
>> > wrote:
>> >
>> >> Chris many other popular apache projects keep the project
>> >> documentation on the project site....take a look at Apache HTTP,
>> >> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
>> >> over to Apache CMS or not but I would rather stick with the
>> >> convention.
>> >>
>> >> Agree on a new logo, if anyone has the skills to come up with one that
>> >> would be great.
>> >>
>> >> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
>> >> <ch...@gmail.com> wrote:
>> >> > Hi all,
>> >> >
>> >> > the question is how we should balance the material between Apache CMS
>> >> > and
>> >> > Confluence. I think that all technical guides and resources should
>> >> > go
>> >> into
>> >> > Confluence - making it the official documentation space, rather than
>> >> just a
>> >> > wiki - and all the high-level reference / 'marketing' / news material
>> >> into
>> >> > the web site.
>> >> >
>> >> > I'm having a look at different Bootstrap themes in order to select a
>> >> > few,
>> >> > submit the initial list and let the people involved decide. As I've
>> >> > already said, I think we should use a vibrant theme that shouts "Hey,
>> >> have
>> >> > a look inside. It's good stuff!" therefore my attention is grabbed by
>> >> > 'landing page' / 'agency' parallax type themes.
>> >> >
>> >> > One thing that is missing though, is a kick-ass Shindig logo. Is
>> >> > someone
>> >> > willing to create one? Raj, if you could suggest a Bootstrap theme
>> >> > that
>> >> > would be great.
>> >> >
>> >> > In the following days, I'll post a selection of themes as a reference
>> >> > and
>> >> > we can vote. Also, I'll try and write down a suggested link
>> >> > structure
>> >> for
>> >> > the new site and also a scaffolding for the technical docs in
>> >> > Confluence.
>> >> >
>> >> > Let me know what you think.
>> >> >
>> >> > Cheers,
>> >> > Chris
>> >> >
>> >> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
>> >> wrote:
>> >> >
>> >> >> OK well for reference check out the website docs [1]. Let me know
>> >> >> if
>> >> >> you have any problems.
>> >> >>
>> >> >> [1] http://shindig.apache.org/documentation_website.html
>> >> >>
>> >> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar
>> >> >> <ra...@gmail.com>
>> >> >> wrote:
>> >> >> > Hi Ryan,
>> >> >> >
>> >> >> > In my work place i am using Confluence. so i don't think there
>> >> >> > will be
>> >> >> > problem to me.
>> >> >> >
>> >> >> > Regards,
>> >> >> > Raj
>> >> >> >
>> >> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com>
>> >> wrote:
>> >> >> >>
>> >> >> >> Chris and Raj, appreciate you both stepping up! Are you familiar
>> >> with
>> >> >> >> how to use Apache CMS to edit the Shindig site?
>> >> >> >>
>> >> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar
>> >> >> >> <raj.janorkar@gmail.com
>> >> >
>> >> >> >> wrote:
>> >> >> >> > I am also in.
>> >> >> >> > though i am new here but ready to help wherever i can.
>> >> >> >> >
>> >> >> >> > Thank you for this great step.
>> >> >> >> >
>> >> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
>> >> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
>> >> >> >> >
>> >> >> >> >> Hi all,
>> >> >> >> >>
>> >> >> >> >> I am willing to take the first step forward on this but I
>> >> >> >> >> expect
>> >> all
>> >> >> >> >> the
>> >> >> >> >> people in this group to contribute / suggest / vote on
>> >> >> >> >> important
>> >> >> things
>> >> >> >> >> that will make the Shindig project come back to life and start
>> >> >> >> >> receiving
>> >> >> >> >> attention. Based on the steps that Ryan suggested:
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> > *1. We use the Shindig site as the place to keep the
>> >> >> documentation.
>> >> >> >> >> > It
>> >> >> >> >> is
>> >> >> >> >> > CMS based [1] so no need to know how to write HTML.*
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> First we need to decide on an awesome & clean theme for the
>> >> website
>> >> >> >> >> that
>> >> >> >> >> will be responsive and attractive. As Bootstrap is already
>> >> >> >> >> being
>> >> >> used
>> >> >> >> >> that
>> >> >> >> >> should be no prob, but we need to use a theme that will rock.
>> >> Please
>> >> >> >> >> suggest themes from other sites that you find attractive and
>> >> >> >> >> user
>> >> >> >> >> friendly. For instance, I find the SailsJS
>> >> >> >> >> <http://sailsjs.org/>
>> >> >> theme
>> >> >> >> >> very clear for reading. Also, if someone could deal with the
>> >> >> >> >> art
>> >> >> work
>> >> >> >> >> that
>> >> >> >> >> would be very useful.
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> >
>> >> >> >> >> > *2. We create a getting started guide, containing the
>> >> >> >> >> > minimal
>> >> set
>> >> >> >> >> > of steps to get someone up and running.*
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> >
>> >> >> >> >> > *3. We create a detailed implementation guide that
>> >> >> >> >> > addresses
>> >> how
>> >> >> >> >> > someone
>> >> >> >> >> > would extend Shindig to build their own implementation.*
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> Next, we need to make a map of the current structure of the
>> >> >> >> >> web
>> >> site
>> >> >> >> >> and
>> >> >> >> >> then suggest alternatives on how the new site should be
>> >> structured.
>> >> >> >> >> The
>> >> >> >> >> key here is that it should be self explanatory and guide you
>> >> >> >> >> step-by-step
>> >> >> >> >> on how to do from the simplest to the most advanced task.
>> >> Newcomers
>> >> >> >> >> should
>> >> >> >> >> feel comfortable with it so that they start with an appetite
>> >> >> >> >> to
>> >> learn
>> >> >> >> >> more
>> >> >> >> >> about this project.
>> >> >> >> >>
>> >> >> >> >> This part requires an initial gathering of all existing
>> >> >> >> >> resources
>> >> and
>> >> >> >> >> cleansing. Everything should be relevant to the latest
>> >> >> >> >> version
>> >> >> >> >> of the framework. A few months ago I had created a GitHub
>> >> project
>> >> >> >> >> <
>> >> https://github.com/theChefArchitect/os-examples-container-embedded>
>> >> >> >> >> with
>> >> >> >> >> a
>> >> >> >> >> sample embedded container in a Spring web app written for this
>> >> >> purpose.
>> >> >> >> >> I've also noticed that the maintenance of the PHP version has
>> >> >> stopped.
>> >> >> >> >> All
>> >> >> >> >> these cluttered resources should be gathered in one place
>> >> initially
>> >> >> and
>> >> >> >> >> then decide which of them should be used as a reference for
>> >> >> >> >> the
>> >> new
>> >> >> >> >> documentation.
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> > *4. In the process of doing this we cleanup/consolidate the
>> >> >> Shindig
>> >> >> >> >> > site
>> >> >> >> >> > and the wiki.*
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> One important thing that should be decided is where the
>> >> >> documentation /
>> >> >> >> >> tutorials should be hosted. At the moment the web site acts
>> >> >> >> >> as a
>> >> >> proxy
>> >> >> >> >> for
>> >> >> >> >> different documentation locations around the web and some
>> >> hard-core
>> >> >> >> >> tech
>> >> >> >> >> docs live under Atlassian's Confulence site
>> >> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's
>> >> >> >> >> the
>> >> >> story
>> >> >> >> >> with that? Will the documentation be hosted under Confluence
>> >> >> >> >> or
>> >> >> under
>> >> >> >> >> the
>> >> >> >> >> web site?
>> >> >> >> >>
>> >> >> >> >> Overall, this task requires collaborative effort and should be
>> >> done
>> >> >> in
>> >> >> >> >> baby
>> >> >> >> >> steps. Documentation / guides are important but then there
>> >> >> >> >> are
>> >> >> plenty
>> >> >> >> >> of
>> >> >> >> >> other stuff needed to make this project gain a vibrant
>> >> >> >> >> community -
>> >> >> e.g.
>> >> >> >> >> gadgets hosted on the site for tutorials and show cases, API
>> >> >> >> >> documentation
>> >> >> >> >> / integration, social media presence, etc.
>> >> >> >> >>
>> >> >> >> >> Looking forward to your responses.
>> >> >> >> >>
>> >> >> >> >> Cheers,
>> >> >> >> >> Chris
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
>> >> rbaxter85@apache.org>
>> >> >> >> >> wrote:
>> >> >> >> >>
>> >> >> >> >> > Does anyone feel especially passionate about this topic and
>> >> want to
>> >> >> >> >> > step up and take the lead on this?
>> >> >> >> >> >
>> >> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
>> >> dbond@globalcad.com>
>> >> >> >> >> wrote:
>> >> >> >> >> > > Hi Ryan,
>> >> >> >> >> > >
>> >> >> >> >> > > This sounds like a really great start. I'm sure a clean
>> >> >> >> >> > > and
>> >> clear
>> >> >> >> >> > getting started guide + detailed implementation guide that
>> >> >> >> >> > can
>> >> be
>> >> >> >> >> > easily
>> >> >> >> >> > located on the Shindig site will make a huge difference on
>> >> >> >> >> > the
>> >> >> >> >> > take-up of
>> >> >> >> >> > this impressive framework.
>> >> >> >> >> > >
>> >> >> >> >> > > Kind regards,
>> >> >> >> >> > >
>> >> >> >> >> > > Darren
>> >> >> >> >> > >
>> >> >> >> >> > >
>> >> >> >> >> >
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >>
>> >> >> >> >> --
>> >> >> >> >> Chris Spiliotopoulos
>> >> >> >> >>
>> >> >> >> >> Solutions Architect
>> >> >> >> >>
>> >> >> >
>> >> >> >
>> >> >>
>> >> >
>> >> >
>> >> >
>> >> > --
>> >> > Chris Spiliotopoulos
>> >> >
>> >> > Solutions Architect
>> >>
>
>
Re: Implementation Guide
Posted by Raj Janorkar <ra...@gmail.com>.
Okay.
So Ryan do you want to put all doco on http://shindig.apache.org/index.html
?
On Thu, Oct 9, 2014 at 9:58 AM, Ryan Baxter <rb...@gmail.com> wrote:
> The logo should not block us, its a nice to have IMO.
>
> The template shouldn't either, although if you guys want to tackle
> that I am fine.
>
> The main point I was making was that other projects are using their
> project sites to serve their documentation and not a separate wiki,
> like the confluence one.
>
> On Wed, Oct 8, 2014 at 7:52 PM, Raj Janorkar <ra...@gmail.com>
> wrote:
> > Hi Ryan,
> >
> > I think we need
> >
> > 1) Great Logo for shindig
> > 2) Attractive yet simple template for doco.
> > 3) Few shindig implementations on web, this will help users to understand
> > how shindig work and what extend it can be enhanced.
> >
> > These will help shindig to attract new users/developers.
> >
> > Sorry i do not have skill to develop logo. If we dont get any i am happy
> to
> > find some font which will look good for name "shindig", let me know.
> >
> >
> > Regards,
> > Raj
> >
> > On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org>
> wrote:
> >
> >> Chris many other popular apache projects keep the project
> >> documentation on the project site....take a look at Apache HTTP,
> >> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
> >> over to Apache CMS or not but I would rather stick with the
> >> convention.
> >>
> >> Agree on a new logo, if anyone has the skills to come up with one that
> >> would be great.
> >>
> >> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
> >> <ch...@gmail.com> wrote:
> >> > Hi all,
> >> >
> >> > the question is how we should balance the material between Apache CMS
> and
> >> > Confluence. I think that all technical guides and resources should go
> >> into
> >> > Confluence - making it the official documentation space, rather than
> >> just a
> >> > wiki - and all the high-level reference / 'marketing' / news material
> >> into
> >> > the web site.
> >> >
> >> > I'm having a look at different Bootstrap themes in order to select a
> few,
> >> > submit the initial list and let the people involved decide. As I've
> >> > already said, I think we should use a vibrant theme that shouts "Hey,
> >> have
> >> > a look inside. It's good stuff!" therefore my attention is grabbed by
> >> > 'landing page' / 'agency' parallax type themes.
> >> >
> >> > One thing that is missing though, is a kick-ass Shindig logo. Is
> someone
> >> > willing to create one? Raj, if you could suggest a Bootstrap theme
> that
> >> > would be great.
> >> >
> >> > In the following days, I'll post a selection of themes as a reference
> and
> >> > we can vote. Also, I'll try and write down a suggested link structure
> >> for
> >> > the new site and also a scaffolding for the technical docs in
> Confluence.
> >> >
> >> > Let me know what you think.
> >> >
> >> > Cheers,
> >> > Chris
> >> >
> >> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
> >> wrote:
> >> >
> >> >> OK well for reference check out the website docs [1]. Let me know if
> >> >> you have any problems.
> >> >>
> >> >> [1] http://shindig.apache.org/documentation_website.html
> >> >>
> >> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <raj.janorkar@gmail.com
> >
> >> >> wrote:
> >> >> > Hi Ryan,
> >> >> >
> >> >> > In my work place i am using Confluence. so i don't think there
> will be
> >> >> > problem to me.
> >> >> >
> >> >> > Regards,
> >> >> > Raj
> >> >> >
> >> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com>
> >> wrote:
> >> >> >>
> >> >> >> Chris and Raj, appreciate you both stepping up! Are you familiar
> >> with
> >> >> >> how to use Apache CMS to edit the Shindig site?
> >> >> >>
> >> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <
> raj.janorkar@gmail.com
> >> >
> >> >> >> wrote:
> >> >> >> > I am also in.
> >> >> >> > though i am new here but ready to help wherever i can.
> >> >> >> >
> >> >> >> > Thank you for this great step.
> >> >> >> >
> >> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> >> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >> >> >> >
> >> >> >> >> Hi all,
> >> >> >> >>
> >> >> >> >> I am willing to take the first step forward on this but I
> expect
> >> all
> >> >> >> >> the
> >> >> >> >> people in this group to contribute / suggest / vote on
> important
> >> >> things
> >> >> >> >> that will make the Shindig project come back to life and start
> >> >> >> >> receiving
> >> >> >> >> attention. Based on the steps that Ryan suggested:
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> > *1. We use the Shindig site as the place to keep the
> >> >> documentation.
> >> >> >> >> > It
> >> >> >> >> is
> >> >> >> >> > CMS based [1] so no need to know how to write HTML.*
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> First we need to decide on an awesome & clean theme for the
> >> website
> >> >> >> >> that
> >> >> >> >> will be responsive and attractive. As Bootstrap is already
> being
> >> >> used
> >> >> >> >> that
> >> >> >> >> should be no prob, but we need to use a theme that will rock.
> >> Please
> >> >> >> >> suggest themes from other sites that you find attractive and
> user
> >> >> >> >> friendly. For instance, I find the SailsJS <
> http://sailsjs.org/>
> >> >> theme
> >> >> >> >> very clear for reading. Also, if someone could deal with the
> art
> >> >> work
> >> >> >> >> that
> >> >> >> >> would be very useful.
> >> >> >> >>
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> >
> >> >> >> >> > *2. We create a getting started guide, containing the
> minimal
> >> set
> >> >> >> >> > of steps to get someone up and running.*
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> >
> >> >> >> >> > *3. We create a detailed implementation guide that addresses
> >> how
> >> >> >> >> > someone
> >> >> >> >> > would extend Shindig to build their own implementation.*
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> Next, we need to make a map of the current structure of the web
> >> site
> >> >> >> >> and
> >> >> >> >> then suggest alternatives on how the new site should be
> >> structured.
> >> >> >> >> The
> >> >> >> >> key here is that it should be self explanatory and guide you
> >> >> >> >> step-by-step
> >> >> >> >> on how to do from the simplest to the most advanced task.
> >> Newcomers
> >> >> >> >> should
> >> >> >> >> feel comfortable with it so that they start with an appetite to
> >> learn
> >> >> >> >> more
> >> >> >> >> about this project.
> >> >> >> >>
> >> >> >> >> This part requires an initial gathering of all existing
> resources
> >> and
> >> >> >> >> cleansing. Everything should be relevant to the latest version
> >> >> >> >> of the framework. A few months ago I had created a GitHub
> >> project
> >> >> >> >> <
> >> https://github.com/theChefArchitect/os-examples-container-embedded>
> >> >> >> >> with
> >> >> >> >> a
> >> >> >> >> sample embedded container in a Spring web app written for this
> >> >> purpose.
> >> >> >> >> I've also noticed that the maintenance of the PHP version has
> >> >> stopped.
> >> >> >> >> All
> >> >> >> >> these cluttered resources should be gathered in one place
> >> initially
> >> >> and
> >> >> >> >> then decide which of them should be used as a reference for the
> >> new
> >> >> >> >> documentation.
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> > *4. In the process of doing this we cleanup/consolidate the
> >> >> Shindig
> >> >> >> >> > site
> >> >> >> >> > and the wiki.*
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> One important thing that should be decided is where the
> >> >> documentation /
> >> >> >> >> tutorials should be hosted. At the moment the web site acts
> as a
> >> >> proxy
> >> >> >> >> for
> >> >> >> >> different documentation locations around the web and some
> >> hard-core
> >> >> >> >> tech
> >> >> >> >> docs live under Atlassian's Confulence site
> >> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's
> the
> >> >> story
> >> >> >> >> with that? Will the documentation be hosted under Confluence
> or
> >> >> under
> >> >> >> >> the
> >> >> >> >> web site?
> >> >> >> >>
> >> >> >> >> Overall, this task requires collaborative effort and should be
> >> done
> >> >> in
> >> >> >> >> baby
> >> >> >> >> steps. Documentation / guides are important but then there are
> >> >> plenty
> >> >> >> >> of
> >> >> >> >> other stuff needed to make this project gain a vibrant
> community -
> >> >> e.g.
> >> >> >> >> gadgets hosted on the site for tutorials and show cases, API
> >> >> >> >> documentation
> >> >> >> >> / integration, social media presence, etc.
> >> >> >> >>
> >> >> >> >> Looking forward to your responses.
> >> >> >> >>
> >> >> >> >> Cheers,
> >> >> >> >> Chris
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
> >> rbaxter85@apache.org>
> >> >> >> >> wrote:
> >> >> >> >>
> >> >> >> >> > Does anyone feel especially passionate about this topic and
> >> want to
> >> >> >> >> > step up and take the lead on this?
> >> >> >> >> >
> >> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
> >> dbond@globalcad.com>
> >> >> >> >> wrote:
> >> >> >> >> > > Hi Ryan,
> >> >> >> >> > >
> >> >> >> >> > > This sounds like a really great start. I'm sure a clean and
> >> clear
> >> >> >> >> > getting started guide + detailed implementation guide that
> can
> >> be
> >> >> >> >> > easily
> >> >> >> >> > located on the Shindig site will make a huge difference on
> the
> >> >> >> >> > take-up of
> >> >> >> >> > this impressive framework.
> >> >> >> >> > >
> >> >> >> >> > > Kind regards,
> >> >> >> >> > >
> >> >> >> >> > > Darren
> >> >> >> >> > >
> >> >> >> >> > >
> >> >> >> >> >
> >> >> >> >>
> >> >> >> >>
> >> >> >> >>
> >> >> >> >> --
> >> >> >> >> Chris Spiliotopoulos
> >> >> >> >>
> >> >> >> >> Solutions Architect
> >> >> >> >>
> >> >> >
> >> >> >
> >> >>
> >> >
> >> >
> >> >
> >> > --
> >> > Chris Spiliotopoulos
> >> >
> >> > Solutions Architect
> >>
>
Re: Implementation Guide
Posted by Ryan Baxter <rb...@gmail.com>.
The logo should not block us, its a nice to have IMO.
The template shouldn't either, although if you guys want to tackle
that I am fine.
The main point I was making was that other projects are using their
project sites to serve their documentation and not a separate wiki,
like the confluence one.
On Wed, Oct 8, 2014 at 7:52 PM, Raj Janorkar <ra...@gmail.com> wrote:
> Hi Ryan,
>
> I think we need
>
> 1) Great Logo for shindig
> 2) Attractive yet simple template for doco.
> 3) Few shindig implementations on web, this will help users to understand
> how shindig work and what extend it can be enhanced.
>
> These will help shindig to attract new users/developers.
>
> Sorry i do not have skill to develop logo. If we dont get any i am happy to
> find some font which will look good for name "shindig", let me know.
>
>
> Regards,
> Raj
>
> On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org> wrote:
>
>> Chris many other popular apache projects keep the project
>> documentation on the project site....take a look at Apache HTTP,
>> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
>> over to Apache CMS or not but I would rather stick with the
>> convention.
>>
>> Agree on a new logo, if anyone has the skills to come up with one that
>> would be great.
>>
>> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
>> <ch...@gmail.com> wrote:
>> > Hi all,
>> >
>> > the question is how we should balance the material between Apache CMS and
>> > Confluence. I think that all technical guides and resources should go
>> into
>> > Confluence - making it the official documentation space, rather than
>> just a
>> > wiki - and all the high-level reference / 'marketing' / news material
>> into
>> > the web site.
>> >
>> > I'm having a look at different Bootstrap themes in order to select a few,
>> > submit the initial list and let the people involved decide. As I've
>> > already said, I think we should use a vibrant theme that shouts "Hey,
>> have
>> > a look inside. It's good stuff!" therefore my attention is grabbed by
>> > 'landing page' / 'agency' parallax type themes.
>> >
>> > One thing that is missing though, is a kick-ass Shindig logo. Is someone
>> > willing to create one? Raj, if you could suggest a Bootstrap theme that
>> > would be great.
>> >
>> > In the following days, I'll post a selection of themes as a reference and
>> > we can vote. Also, I'll try and write down a suggested link structure
>> for
>> > the new site and also a scaffolding for the technical docs in Confluence.
>> >
>> > Let me know what you think.
>> >
>> > Cheers,
>> > Chris
>> >
>> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
>> wrote:
>> >
>> >> OK well for reference check out the website docs [1]. Let me know if
>> >> you have any problems.
>> >>
>> >> [1] http://shindig.apache.org/documentation_website.html
>> >>
>> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <ra...@gmail.com>
>> >> wrote:
>> >> > Hi Ryan,
>> >> >
>> >> > In my work place i am using Confluence. so i don't think there will be
>> >> > problem to me.
>> >> >
>> >> > Regards,
>> >> > Raj
>> >> >
>> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com>
>> wrote:
>> >> >>
>> >> >> Chris and Raj, appreciate you both stepping up! Are you familiar
>> with
>> >> >> how to use Apache CMS to edit the Shindig site?
>> >> >>
>> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <raj.janorkar@gmail.com
>> >
>> >> >> wrote:
>> >> >> > I am also in.
>> >> >> > though i am new here but ready to help wherever i can.
>> >> >> >
>> >> >> > Thank you for this great step.
>> >> >> >
>> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
>> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
>> >> >> >
>> >> >> >> Hi all,
>> >> >> >>
>> >> >> >> I am willing to take the first step forward on this but I expect
>> all
>> >> >> >> the
>> >> >> >> people in this group to contribute / suggest / vote on important
>> >> things
>> >> >> >> that will make the Shindig project come back to life and start
>> >> >> >> receiving
>> >> >> >> attention. Based on the steps that Ryan suggested:
>> >> >> >>
>> >> >> >>
>> >> >> >> > *1. We use the Shindig site as the place to keep the
>> >> documentation.
>> >> >> >> > It
>> >> >> >> is
>> >> >> >> > CMS based [1] so no need to know how to write HTML.*
>> >> >> >>
>> >> >> >>
>> >> >> >> First we need to decide on an awesome & clean theme for the
>> website
>> >> >> >> that
>> >> >> >> will be responsive and attractive. As Bootstrap is already being
>> >> used
>> >> >> >> that
>> >> >> >> should be no prob, but we need to use a theme that will rock.
>> Please
>> >> >> >> suggest themes from other sites that you find attractive and user
>> >> >> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/>
>> >> theme
>> >> >> >> very clear for reading. Also, if someone could deal with the art
>> >> work
>> >> >> >> that
>> >> >> >> would be very useful.
>> >> >> >>
>> >> >> >>
>> >> >> >>
>> >> >> >> >
>> >> >> >> > *2. We create a getting started guide, containing the minimal
>> set
>> >> >> >> > of steps to get someone up and running.*
>> >> >> >>
>> >> >> >>
>> >> >> >> >
>> >> >> >> > *3. We create a detailed implementation guide that addresses
>> how
>> >> >> >> > someone
>> >> >> >> > would extend Shindig to build their own implementation.*
>> >> >> >>
>> >> >> >>
>> >> >> >> Next, we need to make a map of the current structure of the web
>> site
>> >> >> >> and
>> >> >> >> then suggest alternatives on how the new site should be
>> structured.
>> >> >> >> The
>> >> >> >> key here is that it should be self explanatory and guide you
>> >> >> >> step-by-step
>> >> >> >> on how to do from the simplest to the most advanced task.
>> Newcomers
>> >> >> >> should
>> >> >> >> feel comfortable with it so that they start with an appetite to
>> learn
>> >> >> >> more
>> >> >> >> about this project.
>> >> >> >>
>> >> >> >> This part requires an initial gathering of all existing resources
>> and
>> >> >> >> cleansing. Everything should be relevant to the latest version
>> >> >> >> of the framework. A few months ago I had created a GitHub
>> project
>> >> >> >> <
>> https://github.com/theChefArchitect/os-examples-container-embedded>
>> >> >> >> with
>> >> >> >> a
>> >> >> >> sample embedded container in a Spring web app written for this
>> >> purpose.
>> >> >> >> I've also noticed that the maintenance of the PHP version has
>> >> stopped.
>> >> >> >> All
>> >> >> >> these cluttered resources should be gathered in one place
>> initially
>> >> and
>> >> >> >> then decide which of them should be used as a reference for the
>> new
>> >> >> >> documentation.
>> >> >> >>
>> >> >> >>
>> >> >> >> > *4. In the process of doing this we cleanup/consolidate the
>> >> Shindig
>> >> >> >> > site
>> >> >> >> > and the wiki.*
>> >> >> >>
>> >> >> >>
>> >> >> >> One important thing that should be decided is where the
>> >> documentation /
>> >> >> >> tutorials should be hosted. At the moment the web site acts as a
>> >> proxy
>> >> >> >> for
>> >> >> >> different documentation locations around the web and some
>> hard-core
>> >> >> >> tech
>> >> >> >> docs live under Atlassian's Confulence site
>> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the
>> >> story
>> >> >> >> with that? Will the documentation be hosted under Confluence or
>> >> under
>> >> >> >> the
>> >> >> >> web site?
>> >> >> >>
>> >> >> >> Overall, this task requires collaborative effort and should be
>> done
>> >> in
>> >> >> >> baby
>> >> >> >> steps. Documentation / guides are important but then there are
>> >> plenty
>> >> >> >> of
>> >> >> >> other stuff needed to make this project gain a vibrant community -
>> >> e.g.
>> >> >> >> gadgets hosted on the site for tutorials and show cases, API
>> >> >> >> documentation
>> >> >> >> / integration, social media presence, etc.
>> >> >> >>
>> >> >> >> Looking forward to your responses.
>> >> >> >>
>> >> >> >> Cheers,
>> >> >> >> Chris
>> >> >> >>
>> >> >> >>
>> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
>> rbaxter85@apache.org>
>> >> >> >> wrote:
>> >> >> >>
>> >> >> >> > Does anyone feel especially passionate about this topic and
>> want to
>> >> >> >> > step up and take the lead on this?
>> >> >> >> >
>> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
>> dbond@globalcad.com>
>> >> >> >> wrote:
>> >> >> >> > > Hi Ryan,
>> >> >> >> > >
>> >> >> >> > > This sounds like a really great start. I'm sure a clean and
>> clear
>> >> >> >> > getting started guide + detailed implementation guide that can
>> be
>> >> >> >> > easily
>> >> >> >> > located on the Shindig site will make a huge difference on the
>> >> >> >> > take-up of
>> >> >> >> > this impressive framework.
>> >> >> >> > >
>> >> >> >> > > Kind regards,
>> >> >> >> > >
>> >> >> >> > > Darren
>> >> >> >> > >
>> >> >> >> > >
>> >> >> >> >
>> >> >> >>
>> >> >> >>
>> >> >> >>
>> >> >> >> --
>> >> >> >> Chris Spiliotopoulos
>> >> >> >>
>> >> >> >> Solutions Architect
>> >> >> >>
>> >> >
>> >> >
>> >>
>> >
>> >
>> >
>> > --
>> > Chris Spiliotopoulos
>> >
>> > Solutions Architect
>>
Re: Implementation Guide
Posted by Raj Janorkar <ra...@gmail.com>.
Hi Ryan,
I think we need
1) Great Logo for shindig
2) Attractive yet simple template for doco.
3) Few shindig implementations on web, this will help users to understand
how shindig work and what extend it can be enhanced.
These will help shindig to attract new users/developers.
Sorry i do not have skill to develop logo. If we dont get any i am happy to
find some font which will look good for name "shindig", let me know.
Regards,
Raj
On Thu, Oct 9, 2014 at 6:33 AM, Ryan Baxter <rb...@apache.org> wrote:
> Chris many other popular apache projects keep the project
> documentation on the project site....take a look at Apache HTTP,
> Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
> over to Apache CMS or not but I would rather stick with the
> convention.
>
> Agree on a new logo, if anyone has the skills to come up with one that
> would be great.
>
> On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
> <ch...@gmail.com> wrote:
> > Hi all,
> >
> > the question is how we should balance the material between Apache CMS and
> > Confluence. I think that all technical guides and resources should go
> into
> > Confluence - making it the official documentation space, rather than
> just a
> > wiki - and all the high-level reference / 'marketing' / news material
> into
> > the web site.
> >
> > I'm having a look at different Bootstrap themes in order to select a few,
> > submit the initial list and let the people involved decide. As I've
> > already said, I think we should use a vibrant theme that shouts "Hey,
> have
> > a look inside. It's good stuff!" therefore my attention is grabbed by
> > 'landing page' / 'agency' parallax type themes.
> >
> > One thing that is missing though, is a kick-ass Shindig logo. Is someone
> > willing to create one? Raj, if you could suggest a Bootstrap theme that
> > would be great.
> >
> > In the following days, I'll post a selection of themes as a reference and
> > we can vote. Also, I'll try and write down a suggested link structure
> for
> > the new site and also a scaffolding for the technical docs in Confluence.
> >
> > Let me know what you think.
> >
> > Cheers,
> > Chris
> >
> > On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org>
> wrote:
> >
> >> OK well for reference check out the website docs [1]. Let me know if
> >> you have any problems.
> >>
> >> [1] http://shindig.apache.org/documentation_website.html
> >>
> >> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <ra...@gmail.com>
> >> wrote:
> >> > Hi Ryan,
> >> >
> >> > In my work place i am using Confluence. so i don't think there will be
> >> > problem to me.
> >> >
> >> > Regards,
> >> > Raj
> >> >
> >> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com>
> wrote:
> >> >>
> >> >> Chris and Raj, appreciate you both stepping up! Are you familiar
> with
> >> >> how to use Apache CMS to edit the Shindig site?
> >> >>
> >> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <raj.janorkar@gmail.com
> >
> >> >> wrote:
> >> >> > I am also in.
> >> >> > though i am new here but ready to help wherever i can.
> >> >> >
> >> >> > Thank you for this great step.
> >> >> >
> >> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> >> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >> >> >
> >> >> >> Hi all,
> >> >> >>
> >> >> >> I am willing to take the first step forward on this but I expect
> all
> >> >> >> the
> >> >> >> people in this group to contribute / suggest / vote on important
> >> things
> >> >> >> that will make the Shindig project come back to life and start
> >> >> >> receiving
> >> >> >> attention. Based on the steps that Ryan suggested:
> >> >> >>
> >> >> >>
> >> >> >> > *1. We use the Shindig site as the place to keep the
> >> documentation.
> >> >> >> > It
> >> >> >> is
> >> >> >> > CMS based [1] so no need to know how to write HTML.*
> >> >> >>
> >> >> >>
> >> >> >> First we need to decide on an awesome & clean theme for the
> website
> >> >> >> that
> >> >> >> will be responsive and attractive. As Bootstrap is already being
> >> used
> >> >> >> that
> >> >> >> should be no prob, but we need to use a theme that will rock.
> Please
> >> >> >> suggest themes from other sites that you find attractive and user
> >> >> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/>
> >> theme
> >> >> >> very clear for reading. Also, if someone could deal with the art
> >> work
> >> >> >> that
> >> >> >> would be very useful.
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >> >
> >> >> >> > *2. We create a getting started guide, containing the minimal
> set
> >> >> >> > of steps to get someone up and running.*
> >> >> >>
> >> >> >>
> >> >> >> >
> >> >> >> > *3. We create a detailed implementation guide that addresses
> how
> >> >> >> > someone
> >> >> >> > would extend Shindig to build their own implementation.*
> >> >> >>
> >> >> >>
> >> >> >> Next, we need to make a map of the current structure of the web
> site
> >> >> >> and
> >> >> >> then suggest alternatives on how the new site should be
> structured.
> >> >> >> The
> >> >> >> key here is that it should be self explanatory and guide you
> >> >> >> step-by-step
> >> >> >> on how to do from the simplest to the most advanced task.
> Newcomers
> >> >> >> should
> >> >> >> feel comfortable with it so that they start with an appetite to
> learn
> >> >> >> more
> >> >> >> about this project.
> >> >> >>
> >> >> >> This part requires an initial gathering of all existing resources
> and
> >> >> >> cleansing. Everything should be relevant to the latest version
> >> >> >> of the framework. A few months ago I had created a GitHub
> project
> >> >> >> <
> https://github.com/theChefArchitect/os-examples-container-embedded>
> >> >> >> with
> >> >> >> a
> >> >> >> sample embedded container in a Spring web app written for this
> >> purpose.
> >> >> >> I've also noticed that the maintenance of the PHP version has
> >> stopped.
> >> >> >> All
> >> >> >> these cluttered resources should be gathered in one place
> initially
> >> and
> >> >> >> then decide which of them should be used as a reference for the
> new
> >> >> >> documentation.
> >> >> >>
> >> >> >>
> >> >> >> > *4. In the process of doing this we cleanup/consolidate the
> >> Shindig
> >> >> >> > site
> >> >> >> > and the wiki.*
> >> >> >>
> >> >> >>
> >> >> >> One important thing that should be decided is where the
> >> documentation /
> >> >> >> tutorials should be hosted. At the moment the web site acts as a
> >> proxy
> >> >> >> for
> >> >> >> different documentation locations around the web and some
> hard-core
> >> >> >> tech
> >> >> >> docs live under Atlassian's Confulence site
> >> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the
> >> story
> >> >> >> with that? Will the documentation be hosted under Confluence or
> >> under
> >> >> >> the
> >> >> >> web site?
> >> >> >>
> >> >> >> Overall, this task requires collaborative effort and should be
> done
> >> in
> >> >> >> baby
> >> >> >> steps. Documentation / guides are important but then there are
> >> plenty
> >> >> >> of
> >> >> >> other stuff needed to make this project gain a vibrant community -
> >> e.g.
> >> >> >> gadgets hosted on the site for tutorials and show cases, API
> >> >> >> documentation
> >> >> >> / integration, social media presence, etc.
> >> >> >>
> >> >> >> Looking forward to your responses.
> >> >> >>
> >> >> >> Cheers,
> >> >> >> Chris
> >> >> >>
> >> >> >>
> >> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <
> rbaxter85@apache.org>
> >> >> >> wrote:
> >> >> >>
> >> >> >> > Does anyone feel especially passionate about this topic and
> want to
> >> >> >> > step up and take the lead on this?
> >> >> >> >
> >> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <
> dbond@globalcad.com>
> >> >> >> wrote:
> >> >> >> > > Hi Ryan,
> >> >> >> > >
> >> >> >> > > This sounds like a really great start. I'm sure a clean and
> clear
> >> >> >> > getting started guide + detailed implementation guide that can
> be
> >> >> >> > easily
> >> >> >> > located on the Shindig site will make a huge difference on the
> >> >> >> > take-up of
> >> >> >> > this impressive framework.
> >> >> >> > >
> >> >> >> > > Kind regards,
> >> >> >> > >
> >> >> >> > > Darren
> >> >> >> > >
> >> >> >> > >
> >> >> >> >
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >> --
> >> >> >> Chris Spiliotopoulos
> >> >> >>
> >> >> >> Solutions Architect
> >> >> >>
> >> >
> >> >
> >>
> >
> >
> >
> > --
> > Chris Spiliotopoulos
> >
> > Solutions Architect
>
Re: Implementation Guide
Posted by Ryan Baxter <rb...@apache.org>.
Chris many other popular apache projects keep the project
documentation on the project site....take a look at Apache HTTP,
Apache Tomcat, and Apache Hadoop. Not sure if they have all moved
over to Apache CMS or not but I would rather stick with the
convention.
Agree on a new logo, if anyone has the skills to come up with one that
would be great.
On Wed, Oct 8, 2014 at 4:17 AM, Chris Spiliotopoulos
<ch...@gmail.com> wrote:
> Hi all,
>
> the question is how we should balance the material between Apache CMS and
> Confluence. I think that all technical guides and resources should go into
> Confluence - making it the official documentation space, rather than just a
> wiki - and all the high-level reference / 'marketing' / news material into
> the web site.
>
> I'm having a look at different Bootstrap themes in order to select a few,
> submit the initial list and let the people involved decide. As I've
> already said, I think we should use a vibrant theme that shouts "Hey, have
> a look inside. It's good stuff!" therefore my attention is grabbed by
> 'landing page' / 'agency' parallax type themes.
>
> One thing that is missing though, is a kick-ass Shindig logo. Is someone
> willing to create one? Raj, if you could suggest a Bootstrap theme that
> would be great.
>
> In the following days, I'll post a selection of themes as a reference and
> we can vote. Also, I'll try and write down a suggested link structure for
> the new site and also a scaffolding for the technical docs in Confluence.
>
> Let me know what you think.
>
> Cheers,
> Chris
>
> On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org> wrote:
>
>> OK well for reference check out the website docs [1]. Let me know if
>> you have any problems.
>>
>> [1] http://shindig.apache.org/documentation_website.html
>>
>> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <ra...@gmail.com>
>> wrote:
>> > Hi Ryan,
>> >
>> > In my work place i am using Confluence. so i don't think there will be
>> > problem to me.
>> >
>> > Regards,
>> > Raj
>> >
>> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com> wrote:
>> >>
>> >> Chris and Raj, appreciate you both stepping up! Are you familiar with
>> >> how to use Apache CMS to edit the Shindig site?
>> >>
>> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <ra...@gmail.com>
>> >> wrote:
>> >> > I am also in.
>> >> > though i am new here but ready to help wherever i can.
>> >> >
>> >> > Thank you for this great step.
>> >> >
>> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
>> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
>> >> >
>> >> >> Hi all,
>> >> >>
>> >> >> I am willing to take the first step forward on this but I expect all
>> >> >> the
>> >> >> people in this group to contribute / suggest / vote on important
>> things
>> >> >> that will make the Shindig project come back to life and start
>> >> >> receiving
>> >> >> attention. Based on the steps that Ryan suggested:
>> >> >>
>> >> >>
>> >> >> > *1. We use the Shindig site as the place to keep the
>> documentation.
>> >> >> > It
>> >> >> is
>> >> >> > CMS based [1] so no need to know how to write HTML.*
>> >> >>
>> >> >>
>> >> >> First we need to decide on an awesome & clean theme for the website
>> >> >> that
>> >> >> will be responsive and attractive. As Bootstrap is already being
>> used
>> >> >> that
>> >> >> should be no prob, but we need to use a theme that will rock. Please
>> >> >> suggest themes from other sites that you find attractive and user
>> >> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/>
>> theme
>> >> >> very clear for reading. Also, if someone could deal with the art
>> work
>> >> >> that
>> >> >> would be very useful.
>> >> >>
>> >> >>
>> >> >>
>> >> >> >
>> >> >> > *2. We create a getting started guide, containing the minimal set
>> >> >> > of steps to get someone up and running.*
>> >> >>
>> >> >>
>> >> >> >
>> >> >> > *3. We create a detailed implementation guide that addresses how
>> >> >> > someone
>> >> >> > would extend Shindig to build their own implementation.*
>> >> >>
>> >> >>
>> >> >> Next, we need to make a map of the current structure of the web site
>> >> >> and
>> >> >> then suggest alternatives on how the new site should be structured.
>> >> >> The
>> >> >> key here is that it should be self explanatory and guide you
>> >> >> step-by-step
>> >> >> on how to do from the simplest to the most advanced task. Newcomers
>> >> >> should
>> >> >> feel comfortable with it so that they start with an appetite to learn
>> >> >> more
>> >> >> about this project.
>> >> >>
>> >> >> This part requires an initial gathering of all existing resources and
>> >> >> cleansing. Everything should be relevant to the latest version
>> >> >> of the framework. A few months ago I had created a GitHub project
>> >> >> <https://github.com/theChefArchitect/os-examples-container-embedded>
>> >> >> with
>> >> >> a
>> >> >> sample embedded container in a Spring web app written for this
>> purpose.
>> >> >> I've also noticed that the maintenance of the PHP version has
>> stopped.
>> >> >> All
>> >> >> these cluttered resources should be gathered in one place initially
>> and
>> >> >> then decide which of them should be used as a reference for the new
>> >> >> documentation.
>> >> >>
>> >> >>
>> >> >> > *4. In the process of doing this we cleanup/consolidate the
>> Shindig
>> >> >> > site
>> >> >> > and the wiki.*
>> >> >>
>> >> >>
>> >> >> One important thing that should be decided is where the
>> documentation /
>> >> >> tutorials should be hosted. At the moment the web site acts as a
>> proxy
>> >> >> for
>> >> >> different documentation locations around the web and some hard-core
>> >> >> tech
>> >> >> docs live under Atlassian's Confulence site
>> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the
>> story
>> >> >> with that? Will the documentation be hosted under Confluence or
>> under
>> >> >> the
>> >> >> web site?
>> >> >>
>> >> >> Overall, this task requires collaborative effort and should be done
>> in
>> >> >> baby
>> >> >> steps. Documentation / guides are important but then there are
>> plenty
>> >> >> of
>> >> >> other stuff needed to make this project gain a vibrant community -
>> e.g.
>> >> >> gadgets hosted on the site for tutorials and show cases, API
>> >> >> documentation
>> >> >> / integration, social media presence, etc.
>> >> >>
>> >> >> Looking forward to your responses.
>> >> >>
>> >> >> Cheers,
>> >> >> Chris
>> >> >>
>> >> >>
>> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org>
>> >> >> wrote:
>> >> >>
>> >> >> > Does anyone feel especially passionate about this topic and want to
>> >> >> > step up and take the lead on this?
>> >> >> >
>> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
>> >> >> wrote:
>> >> >> > > Hi Ryan,
>> >> >> > >
>> >> >> > > This sounds like a really great start. I'm sure a clean and clear
>> >> >> > getting started guide + detailed implementation guide that can be
>> >> >> > easily
>> >> >> > located on the Shindig site will make a huge difference on the
>> >> >> > take-up of
>> >> >> > this impressive framework.
>> >> >> > >
>> >> >> > > Kind regards,
>> >> >> > >
>> >> >> > > Darren
>> >> >> > >
>> >> >> > >
>> >> >> >
>> >> >>
>> >> >>
>> >> >>
>> >> >> --
>> >> >> Chris Spiliotopoulos
>> >> >>
>> >> >> Solutions Architect
>> >> >>
>> >
>> >
>>
>
>
>
> --
> Chris Spiliotopoulos
>
> Solutions Architect
Re: Implementation Guide
Posted by Chris Spiliotopoulos <ch...@gmail.com>.
Hi all,
the question is how we should balance the material between Apache CMS and
Confluence. I think that all technical guides and resources should go into
Confluence - making it the official documentation space, rather than just a
wiki - and all the high-level reference / 'marketing' / news material into
the web site.
I'm having a look at different Bootstrap themes in order to select a few,
submit the initial list and let the people involved decide. As I've
already said, I think we should use a vibrant theme that shouts "Hey, have
a look inside. It's good stuff!" therefore my attention is grabbed by
'landing page' / 'agency' parallax type themes.
One thing that is missing though, is a kick-ass Shindig logo. Is someone
willing to create one? Raj, if you could suggest a Bootstrap theme that
would be great.
In the following days, I'll post a selection of themes as a reference and
we can vote. Also, I'll try and write down a suggested link structure for
the new site and also a scaffolding for the technical docs in Confluence.
Let me know what you think.
Cheers,
Chris
On Wed, Oct 8, 2014 at 2:27 AM, Ryan Baxter <rb...@apache.org> wrote:
> OK well for reference check out the website docs [1]. Let me know if
> you have any problems.
>
> [1] http://shindig.apache.org/documentation_website.html
>
> On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <ra...@gmail.com>
> wrote:
> > Hi Ryan,
> >
> > In my work place i am using Confluence. so i don't think there will be
> > problem to me.
> >
> > Regards,
> > Raj
> >
> > On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com> wrote:
> >>
> >> Chris and Raj, appreciate you both stepping up! Are you familiar with
> >> how to use Apache CMS to edit the Shindig site?
> >>
> >> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <ra...@gmail.com>
> >> wrote:
> >> > I am also in.
> >> > though i am new here but ready to help wherever i can.
> >> >
> >> > Thank you for this great step.
> >> >
> >> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> >> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >> >
> >> >> Hi all,
> >> >>
> >> >> I am willing to take the first step forward on this but I expect all
> >> >> the
> >> >> people in this group to contribute / suggest / vote on important
> things
> >> >> that will make the Shindig project come back to life and start
> >> >> receiving
> >> >> attention. Based on the steps that Ryan suggested:
> >> >>
> >> >>
> >> >> > *1. We use the Shindig site as the place to keep the
> documentation.
> >> >> > It
> >> >> is
> >> >> > CMS based [1] so no need to know how to write HTML.*
> >> >>
> >> >>
> >> >> First we need to decide on an awesome & clean theme for the website
> >> >> that
> >> >> will be responsive and attractive. As Bootstrap is already being
> used
> >> >> that
> >> >> should be no prob, but we need to use a theme that will rock. Please
> >> >> suggest themes from other sites that you find attractive and user
> >> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/>
> theme
> >> >> very clear for reading. Also, if someone could deal with the art
> work
> >> >> that
> >> >> would be very useful.
> >> >>
> >> >>
> >> >>
> >> >> >
> >> >> > *2. We create a getting started guide, containing the minimal set
> >> >> > of steps to get someone up and running.*
> >> >>
> >> >>
> >> >> >
> >> >> > *3. We create a detailed implementation guide that addresses how
> >> >> > someone
> >> >> > would extend Shindig to build their own implementation.*
> >> >>
> >> >>
> >> >> Next, we need to make a map of the current structure of the web site
> >> >> and
> >> >> then suggest alternatives on how the new site should be structured.
> >> >> The
> >> >> key here is that it should be self explanatory and guide you
> >> >> step-by-step
> >> >> on how to do from the simplest to the most advanced task. Newcomers
> >> >> should
> >> >> feel comfortable with it so that they start with an appetite to learn
> >> >> more
> >> >> about this project.
> >> >>
> >> >> This part requires an initial gathering of all existing resources and
> >> >> cleansing. Everything should be relevant to the latest version
> >> >> of the framework. A few months ago I had created a GitHub project
> >> >> <https://github.com/theChefArchitect/os-examples-container-embedded>
> >> >> with
> >> >> a
> >> >> sample embedded container in a Spring web app written for this
> purpose.
> >> >> I've also noticed that the maintenance of the PHP version has
> stopped.
> >> >> All
> >> >> these cluttered resources should be gathered in one place initially
> and
> >> >> then decide which of them should be used as a reference for the new
> >> >> documentation.
> >> >>
> >> >>
> >> >> > *4. In the process of doing this we cleanup/consolidate the
> Shindig
> >> >> > site
> >> >> > and the wiki.*
> >> >>
> >> >>
> >> >> One important thing that should be decided is where the
> documentation /
> >> >> tutorials should be hosted. At the moment the web site acts as a
> proxy
> >> >> for
> >> >> different documentation locations around the web and some hard-core
> >> >> tech
> >> >> docs live under Atlassian's Confulence site
> >> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the
> story
> >> >> with that? Will the documentation be hosted under Confluence or
> under
> >> >> the
> >> >> web site?
> >> >>
> >> >> Overall, this task requires collaborative effort and should be done
> in
> >> >> baby
> >> >> steps. Documentation / guides are important but then there are
> plenty
> >> >> of
> >> >> other stuff needed to make this project gain a vibrant community -
> e.g.
> >> >> gadgets hosted on the site for tutorials and show cases, API
> >> >> documentation
> >> >> / integration, social media presence, etc.
> >> >>
> >> >> Looking forward to your responses.
> >> >>
> >> >> Cheers,
> >> >> Chris
> >> >>
> >> >>
> >> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org>
> >> >> wrote:
> >> >>
> >> >> > Does anyone feel especially passionate about this topic and want to
> >> >> > step up and take the lead on this?
> >> >> >
> >> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
> >> >> wrote:
> >> >> > > Hi Ryan,
> >> >> > >
> >> >> > > This sounds like a really great start. I'm sure a clean and clear
> >> >> > getting started guide + detailed implementation guide that can be
> >> >> > easily
> >> >> > located on the Shindig site will make a huge difference on the
> >> >> > take-up of
> >> >> > this impressive framework.
> >> >> > >
> >> >> > > Kind regards,
> >> >> > >
> >> >> > > Darren
> >> >> > >
> >> >> > >
> >> >> >
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >> Chris Spiliotopoulos
> >> >>
> >> >> Solutions Architect
> >> >>
> >
> >
>
--
Chris Spiliotopoulos
Solutions Architect
Re: Implementation Guide
Posted by Ryan Baxter <rb...@apache.org>.
OK well for reference check out the website docs [1]. Let me know if
you have any problems.
[1] http://shindig.apache.org/documentation_website.html
On Tue, Oct 7, 2014 at 7:24 PM, Raj Janorkar <ra...@gmail.com> wrote:
> Hi Ryan,
>
> In my work place i am using Confluence. so i don't think there will be
> problem to me.
>
> Regards,
> Raj
>
> On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com> wrote:
>>
>> Chris and Raj, appreciate you both stepping up! Are you familiar with
>> how to use Apache CMS to edit the Shindig site?
>>
>> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <ra...@gmail.com>
>> wrote:
>> > I am also in.
>> > though i am new here but ready to help wherever i can.
>> >
>> > Thank you for this great step.
>> >
>> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
>> > chrysanthos.spiliotopoulos@gmail.com> wrote:
>> >
>> >> Hi all,
>> >>
>> >> I am willing to take the first step forward on this but I expect all
>> >> the
>> >> people in this group to contribute / suggest / vote on important things
>> >> that will make the Shindig project come back to life and start
>> >> receiving
>> >> attention. Based on the steps that Ryan suggested:
>> >>
>> >>
>> >> > *1. We use the Shindig site as the place to keep the documentation.
>> >> > It
>> >> is
>> >> > CMS based [1] so no need to know how to write HTML.*
>> >>
>> >>
>> >> First we need to decide on an awesome & clean theme for the website
>> >> that
>> >> will be responsive and attractive. As Bootstrap is already being used
>> >> that
>> >> should be no prob, but we need to use a theme that will rock. Please
>> >> suggest themes from other sites that you find attractive and user
>> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/> theme
>> >> very clear for reading. Also, if someone could deal with the art work
>> >> that
>> >> would be very useful.
>> >>
>> >>
>> >>
>> >> >
>> >> > *2. We create a getting started guide, containing the minimal set
>> >> > of steps to get someone up and running.*
>> >>
>> >>
>> >> >
>> >> > *3. We create a detailed implementation guide that addresses how
>> >> > someone
>> >> > would extend Shindig to build their own implementation.*
>> >>
>> >>
>> >> Next, we need to make a map of the current structure of the web site
>> >> and
>> >> then suggest alternatives on how the new site should be structured.
>> >> The
>> >> key here is that it should be self explanatory and guide you
>> >> step-by-step
>> >> on how to do from the simplest to the most advanced task. Newcomers
>> >> should
>> >> feel comfortable with it so that they start with an appetite to learn
>> >> more
>> >> about this project.
>> >>
>> >> This part requires an initial gathering of all existing resources and
>> >> cleansing. Everything should be relevant to the latest version
>> >> of the framework. A few months ago I had created a GitHub project
>> >> <https://github.com/theChefArchitect/os-examples-container-embedded>
>> >> with
>> >> a
>> >> sample embedded container in a Spring web app written for this purpose.
>> >> I've also noticed that the maintenance of the PHP version has stopped.
>> >> All
>> >> these cluttered resources should be gathered in one place initially and
>> >> then decide which of them should be used as a reference for the new
>> >> documentation.
>> >>
>> >>
>> >> > *4. In the process of doing this we cleanup/consolidate the Shindig
>> >> > site
>> >> > and the wiki.*
>> >>
>> >>
>> >> One important thing that should be decided is where the documentation /
>> >> tutorials should be hosted. At the moment the web site acts as a proxy
>> >> for
>> >> different documentation locations around the web and some hard-core
>> >> tech
>> >> docs live under Atlassian's Confulence site
>> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the story
>> >> with that? Will the documentation be hosted under Confluence or under
>> >> the
>> >> web site?
>> >>
>> >> Overall, this task requires collaborative effort and should be done in
>> >> baby
>> >> steps. Documentation / guides are important but then there are plenty
>> >> of
>> >> other stuff needed to make this project gain a vibrant community - e.g.
>> >> gadgets hosted on the site for tutorials and show cases, API
>> >> documentation
>> >> / integration, social media presence, etc.
>> >>
>> >> Looking forward to your responses.
>> >>
>> >> Cheers,
>> >> Chris
>> >>
>> >>
>> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org>
>> >> wrote:
>> >>
>> >> > Does anyone feel especially passionate about this topic and want to
>> >> > step up and take the lead on this?
>> >> >
>> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
>> >> wrote:
>> >> > > Hi Ryan,
>> >> > >
>> >> > > This sounds like a really great start. I'm sure a clean and clear
>> >> > getting started guide + detailed implementation guide that can be
>> >> > easily
>> >> > located on the Shindig site will make a huge difference on the
>> >> > take-up of
>> >> > this impressive framework.
>> >> > >
>> >> > > Kind regards,
>> >> > >
>> >> > > Darren
>> >> > >
>> >> > >
>> >> >
>> >>
>> >>
>> >>
>> >> --
>> >> Chris Spiliotopoulos
>> >>
>> >> Solutions Architect
>> >>
>
>
Re: Implementation Guide
Posted by Raj Janorkar <ra...@gmail.com>.
Hi Ryan,
In my work place i am using Confluence. so i don't think there will be
problem to me.
Regards,
Raj
On Tue, Oct 7, 2014 at 7:17 AM, Ryan Baxter <rb...@gmail.com> wrote:
> Chris and Raj, appreciate you both stepping up! Are you familiar with
> how to use Apache CMS to edit the Shindig site?
>
> On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <ra...@gmail.com>
> wrote:
> > I am also in.
> > though i am new here but ready to help wherever i can.
> >
> > Thank you for this great step.
> >
> > On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> > chrysanthos.spiliotopoulos@gmail.com> wrote:
> >
> >> Hi all,
> >>
> >> I am willing to take the first step forward on this but I expect all the
> >> people in this group to contribute / suggest / vote on important things
> >> that will make the Shindig project come back to life and start receiving
> >> attention. Based on the steps that Ryan suggested:
> >>
> >>
> >> > *1. We use the Shindig site as the place to keep the documentation.
> It
> >> is
> >> > CMS based [1] so no need to know how to write HTML.*
> >>
> >>
> >> First we need to decide on an awesome & clean theme for the website that
> >> will be responsive and attractive. As Bootstrap is already being used
> that
> >> should be no prob, but we need to use a theme that will rock. Please
> >> suggest themes from other sites that you find attractive and user
> >> friendly. For instance, I find the SailsJS <http://sailsjs.org/> theme
> >> very clear for reading. Also, if someone could deal with the art work
> that
> >> would be very useful.
> >>
> >>
> >>
> >> >
> >> > *2. We create a getting started guide, containing the minimal set
> >> > of steps to get someone up and running.*
> >>
> >>
> >> >
> >> > *3. We create a detailed implementation guide that addresses how
> someone
> >> > would extend Shindig to build their own implementation.*
> >>
> >>
> >> Next, we need to make a map of the current structure of the web site and
> >> then suggest alternatives on how the new site should be structured. The
> >> key here is that it should be self explanatory and guide you
> step-by-step
> >> on how to do from the simplest to the most advanced task. Newcomers
> should
> >> feel comfortable with it so that they start with an appetite to learn
> more
> >> about this project.
> >>
> >> This part requires an initial gathering of all existing resources and
> >> cleansing. Everything should be relevant to the latest version
> >> of the framework. A few months ago I had created a GitHub project
> >> <https://github.com/theChefArchitect/os-examples-container-embedded>
> with
> >> a
> >> sample embedded container in a Spring web app written for this purpose.
> >> I've also noticed that the maintenance of the PHP version has stopped.
> All
> >> these cluttered resources should be gathered in one place initially and
> >> then decide which of them should be used as a reference for the new
> >> documentation.
> >>
> >>
> >> > *4. In the process of doing this we cleanup/consolidate the Shindig
> site
> >> > and the wiki.*
> >>
> >>
> >> One important thing that should be decided is where the documentation /
> >> tutorials should be hosted. At the moment the web site acts as a proxy
> for
> >> different documentation locations around the web and some hard-core tech
> >> docs live under Atlassian's Confulence site
> >> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the story
> >> with that? Will the documentation be hosted under Confluence or under
> the
> >> web site?
> >>
> >> Overall, this task requires collaborative effort and should be done in
> baby
> >> steps. Documentation / guides are important but then there are plenty
> of
> >> other stuff needed to make this project gain a vibrant community - e.g.
> >> gadgets hosted on the site for tutorials and show cases, API
> documentation
> >> / integration, social media presence, etc.
> >>
> >> Looking forward to your responses.
> >>
> >> Cheers,
> >> Chris
> >>
> >>
> >> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org>
> wrote:
> >>
> >> > Does anyone feel especially passionate about this topic and want to
> >> > step up and take the lead on this?
> >> >
> >> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
> >> wrote:
> >> > > Hi Ryan,
> >> > >
> >> > > This sounds like a really great start. I'm sure a clean and clear
> >> > getting started guide + detailed implementation guide that can be
> easily
> >> > located on the Shindig site will make a huge difference on the
> take-up of
> >> > this impressive framework.
> >> > >
> >> > > Kind regards,
> >> > >
> >> > > Darren
> >> > >
> >> > >
> >> >
> >>
> >>
> >>
> >> --
> >> Chris Spiliotopoulos
> >>
> >> Solutions Architect
> >>
>
Re: Implementation Guide
Posted by Ryan Baxter <rb...@gmail.com>.
Chris and Raj, appreciate you both stepping up! Are you familiar with
how to use Apache CMS to edit the Shindig site?
On Thu, Oct 2, 2014 at 7:09 AM, Raj Janorkar <ra...@gmail.com> wrote:
> I am also in.
> though i am new here but ready to help wherever i can.
>
> Thank you for this great step.
>
> On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
> chrysanthos.spiliotopoulos@gmail.com> wrote:
>
>> Hi all,
>>
>> I am willing to take the first step forward on this but I expect all the
>> people in this group to contribute / suggest / vote on important things
>> that will make the Shindig project come back to life and start receiving
>> attention. Based on the steps that Ryan suggested:
>>
>>
>> > *1. We use the Shindig site as the place to keep the documentation. It
>> is
>> > CMS based [1] so no need to know how to write HTML.*
>>
>>
>> First we need to decide on an awesome & clean theme for the website that
>> will be responsive and attractive. As Bootstrap is already being used that
>> should be no prob, but we need to use a theme that will rock. Please
>> suggest themes from other sites that you find attractive and user
>> friendly. For instance, I find the SailsJS <http://sailsjs.org/> theme
>> very clear for reading. Also, if someone could deal with the art work that
>> would be very useful.
>>
>>
>>
>> >
>> > *2. We create a getting started guide, containing the minimal set
>> > of steps to get someone up and running.*
>>
>>
>> >
>> > *3. We create a detailed implementation guide that addresses how someone
>> > would extend Shindig to build their own implementation.*
>>
>>
>> Next, we need to make a map of the current structure of the web site and
>> then suggest alternatives on how the new site should be structured. The
>> key here is that it should be self explanatory and guide you step-by-step
>> on how to do from the simplest to the most advanced task. Newcomers should
>> feel comfortable with it so that they start with an appetite to learn more
>> about this project.
>>
>> This part requires an initial gathering of all existing resources and
>> cleansing. Everything should be relevant to the latest version
>> of the framework. A few months ago I had created a GitHub project
>> <https://github.com/theChefArchitect/os-examples-container-embedded> with
>> a
>> sample embedded container in a Spring web app written for this purpose.
>> I've also noticed that the maintenance of the PHP version has stopped. All
>> these cluttered resources should be gathered in one place initially and
>> then decide which of them should be used as a reference for the new
>> documentation.
>>
>>
>> > *4. In the process of doing this we cleanup/consolidate the Shindig site
>> > and the wiki.*
>>
>>
>> One important thing that should be decided is where the documentation /
>> tutorials should be hosted. At the moment the web site acts as a proxy for
>> different documentation locations around the web and some hard-core tech
>> docs live under Atlassian's Confulence site
>> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the story
>> with that? Will the documentation be hosted under Confluence or under the
>> web site?
>>
>> Overall, this task requires collaborative effort and should be done in baby
>> steps. Documentation / guides are important but then there are plenty of
>> other stuff needed to make this project gain a vibrant community - e.g.
>> gadgets hosted on the site for tutorials and show cases, API documentation
>> / integration, social media presence, etc.
>>
>> Looking forward to your responses.
>>
>> Cheers,
>> Chris
>>
>>
>> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org> wrote:
>>
>> > Does anyone feel especially passionate about this topic and want to
>> > step up and take the lead on this?
>> >
>> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
>> wrote:
>> > > Hi Ryan,
>> > >
>> > > This sounds like a really great start. I'm sure a clean and clear
>> > getting started guide + detailed implementation guide that can be easily
>> > located on the Shindig site will make a huge difference on the take-up of
>> > this impressive framework.
>> > >
>> > > Kind regards,
>> > >
>> > > Darren
>> > >
>> > >
>> >
>>
>>
>>
>> --
>> Chris Spiliotopoulos
>>
>> Solutions Architect
>>
Re: Implementation Guide
Posted by Raj Janorkar <ra...@gmail.com>.
I am also in.
though i am new here but ready to help wherever i can.
Thank you for this great step.
On Thu, Oct 2, 2014 at 7:14 PM, Chris Spiliotopoulos <
chrysanthos.spiliotopoulos@gmail.com> wrote:
> Hi all,
>
> I am willing to take the first step forward on this but I expect all the
> people in this group to contribute / suggest / vote on important things
> that will make the Shindig project come back to life and start receiving
> attention. Based on the steps that Ryan suggested:
>
>
> > *1. We use the Shindig site as the place to keep the documentation. It
> is
> > CMS based [1] so no need to know how to write HTML.*
>
>
> First we need to decide on an awesome & clean theme for the website that
> will be responsive and attractive. As Bootstrap is already being used that
> should be no prob, but we need to use a theme that will rock. Please
> suggest themes from other sites that you find attractive and user
> friendly. For instance, I find the SailsJS <http://sailsjs.org/> theme
> very clear for reading. Also, if someone could deal with the art work that
> would be very useful.
>
>
>
> >
> > *2. We create a getting started guide, containing the minimal set
> > of steps to get someone up and running.*
>
>
> >
> > *3. We create a detailed implementation guide that addresses how someone
> > would extend Shindig to build their own implementation.*
>
>
> Next, we need to make a map of the current structure of the web site and
> then suggest alternatives on how the new site should be structured. The
> key here is that it should be self explanatory and guide you step-by-step
> on how to do from the simplest to the most advanced task. Newcomers should
> feel comfortable with it so that they start with an appetite to learn more
> about this project.
>
> This part requires an initial gathering of all existing resources and
> cleansing. Everything should be relevant to the latest version
> of the framework. A few months ago I had created a GitHub project
> <https://github.com/theChefArchitect/os-examples-container-embedded> with
> a
> sample embedded container in a Spring web app written for this purpose.
> I've also noticed that the maintenance of the PHP version has stopped. All
> these cluttered resources should be gathered in one place initially and
> then decide which of them should be used as a reference for the new
> documentation.
>
>
> > *4. In the process of doing this we cleanup/consolidate the Shindig site
> > and the wiki.*
>
>
> One important thing that should be decided is where the documentation /
> tutorials should be hosted. At the moment the web site acts as a proxy for
> different documentation locations around the web and some hard-core tech
> docs live under Atlassian's Confulence site
> <https://opensocial.atlassian.net/wiki/display/OSREF>. What's the story
> with that? Will the documentation be hosted under Confluence or under the
> web site?
>
> Overall, this task requires collaborative effort and should be done in baby
> steps. Documentation / guides are important but then there are plenty of
> other stuff needed to make this project gain a vibrant community - e.g.
> gadgets hosted on the site for tutorials and show cases, API documentation
> / integration, social media presence, etc.
>
> Looking forward to your responses.
>
> Cheers,
> Chris
>
>
> On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org> wrote:
>
> > Does anyone feel especially passionate about this topic and want to
> > step up and take the lead on this?
> >
> > On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com>
> wrote:
> > > Hi Ryan,
> > >
> > > This sounds like a really great start. I'm sure a clean and clear
> > getting started guide + detailed implementation guide that can be easily
> > located on the Shindig site will make a huge difference on the take-up of
> > this impressive framework.
> > >
> > > Kind regards,
> > >
> > > Darren
> > >
> > >
> >
>
>
>
> --
> Chris Spiliotopoulos
>
> Solutions Architect
>
Re: Implementation Guide
Posted by Chris Spiliotopoulos <ch...@gmail.com>.
Hi all,
I am willing to take the first step forward on this but I expect all the
people in this group to contribute / suggest / vote on important things
that will make the Shindig project come back to life and start receiving
attention. Based on the steps that Ryan suggested:
> *1. We use the Shindig site as the place to keep the documentation. It is
> CMS based [1] so no need to know how to write HTML.*
First we need to decide on an awesome & clean theme for the website that
will be responsive and attractive. As Bootstrap is already being used that
should be no prob, but we need to use a theme that will rock. Please
suggest themes from other sites that you find attractive and user
friendly. For instance, I find the SailsJS <http://sailsjs.org/> theme
very clear for reading. Also, if someone could deal with the art work that
would be very useful.
>
> *2. We create a getting started guide, containing the minimal set
> of steps to get someone up and running.*
>
> *3. We create a detailed implementation guide that addresses how someone
> would extend Shindig to build their own implementation.*
Next, we need to make a map of the current structure of the web site and
then suggest alternatives on how the new site should be structured. The
key here is that it should be self explanatory and guide you step-by-step
on how to do from the simplest to the most advanced task. Newcomers should
feel comfortable with it so that they start with an appetite to learn more
about this project.
This part requires an initial gathering of all existing resources and
cleansing. Everything should be relevant to the latest version
of the framework. A few months ago I had created a GitHub project
<https://github.com/theChefArchitect/os-examples-container-embedded> with a
sample embedded container in a Spring web app written for this purpose.
I've also noticed that the maintenance of the PHP version has stopped. All
these cluttered resources should be gathered in one place initially and
then decide which of them should be used as a reference for the new
documentation.
> *4. In the process of doing this we cleanup/consolidate the Shindig site
> and the wiki.*
One important thing that should be decided is where the documentation /
tutorials should be hosted. At the moment the web site acts as a proxy for
different documentation locations around the web and some hard-core tech
docs live under Atlassian's Confulence site
<https://opensocial.atlassian.net/wiki/display/OSREF>. What's the story
with that? Will the documentation be hosted under Confluence or under the
web site?
Overall, this task requires collaborative effort and should be done in baby
steps. Documentation / guides are important but then there are plenty of
other stuff needed to make this project gain a vibrant community - e.g.
gadgets hosted on the site for tutorials and show cases, API documentation
/ integration, social media presence, etc.
Looking forward to your responses.
Cheers,
Chris
On Thu, Oct 2, 2014 at 12:12 AM, Ryan Baxter <rb...@apache.org> wrote:
> Does anyone feel especially passionate about this topic and want to
> step up and take the lead on this?
>
> On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com> wrote:
> > Hi Ryan,
> >
> > This sounds like a really great start. I'm sure a clean and clear
> getting started guide + detailed implementation guide that can be easily
> located on the Shindig site will make a huge difference on the take-up of
> this impressive framework.
> >
> > Kind regards,
> >
> > Darren
> >
> >
>
--
Chris Spiliotopoulos
Solutions Architect
Re: Implementation Guide
Posted by Ryan Baxter <rb...@apache.org>.
Does anyone feel especially passionate about this topic and want to
step up and take the lead on this?
On Wed, Sep 17, 2014 at 4:26 AM, Darren Bond <db...@globalcad.com> wrote:
> Hi Ryan,
>
> This sounds like a really great start. I'm sure a clean and clear getting started guide + detailed implementation guide that can be easily located on the Shindig site will make a huge difference on the take-up of this impressive framework.
>
> Kind regards,
>
> Darren
>
>
RE: Implementation Guide
Posted by Darren Bond <db...@globalcad.com>.
Hi Ryan,
This sounds like a really great start. I'm sure a clean and clear getting started guide + detailed implementation guide that can be easily located on the Shindig site will make a huge difference on the take-up of this impressive framework.
Kind regards,
Darren
Re: Implementation Guide
Posted by Ryan Baxter <rb...@gmail.com>.
Wow guess I struck a nerve....a good nerve ;)
I agree with everyones points, in fact when I was starting my journey
into OpenSocial I had the same thoughts and same hopes. Unfortunately
I was never really every to build great documentation. Fact of the
matter is that as with any open source project, interest comes and
goes. We all have day jobs and I assume most of us become involved in
open source projects because they relate to our jobs and it is a
mutually beneficial relationship. As peoples jobs change their
commitment to the projects change and a vibrant community of
contributors is needed to pick up the pieces. I myself had this
happen recently, I no longer work on OpenSocial and Shindig in my day
job anymore. I think the fact that we have outdated and missing
documentation is because people have moved on to other projects and we
haven't had the contributions from the community to pick up the
pieces. I think this is just the flow any open source project goes
through.
As far as trying to address the documentation needs across all
OpenSocial related sites, I think that is too big of a task to tackle
(again it comes down to active contributors). To be honest I am not
sure how active the OpenSocial Foundation is these days. I know they
were contributiong pieces of the spec to the W3C org, not the whole
thing and not the gadget portion of the spec, but I have no seen any
information about this communicated to the community. I would prefer
to tackle one thing at a time, and the only thing this community
controls is the Shindig documentation.
@Chris, I hope you are still willing to help out even though I don't
think we can address all of your concerns.
I think Matt's idea about having a getting started guide is also a
great idea. However I would like to keep both the implementation
guide and the getting started guide on the website instead of the
wiki.
Here is what I propose.
1. We use the Shindig site as the place to keep the documentation.
It is CMS based [1] so no need to know how to write HTML.
2. We create a getting started guide, containing the minimal set of
steps to get someone up and running.
3. We create a detailed implementation guide that addresses how
someone would extend Shindig to build their own implementation.
4. In the process of doing this we cleanup/consolidate the Shindig
site and the wiki.
What does everyone think?
[1] http://www.apache.org/dev/cms.html
On Tue, Sep 16, 2014 at 9:29 AM, Raj Janorkar <ra...@gmail.com> wrote:
> Hi All,
>
> When i started 1 month back i was totally fucked up, still i am fucked up
> because of lack of documentation. (sorry for bad words).
>
> Still trying to understand few things, for those no documentation. I am
> doing my own research for everything.
>
> I am really thankful to Ryan who helped me lot.
>
> its really good idea to have good documentation.
>
> Regards,
> Raj
>
>
>
> On Tue, Sep 16, 2014 at 10:08 PM, Ryan Baxter <rb...@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
>>
Re: Implementation Guide
Posted by Raj Janorkar <ra...@gmail.com>.
Hi All,
When i started 1 month back i was totally fucked up, still i am fucked up
because of lack of documentation. (sorry for bad words).
Still trying to understand few things, for those no documentation. I am
doing my own research for everything.
I am really thankful to Ryan who helped me lot.
its really good idea to have good documentation.
Regards,
Raj
On Tue, Sep 16, 2014 at 10:08 PM, Ryan Baxter <rb...@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
>