You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Emmanuel Lecharny <el...@gmail.com> on 2007/03/19 11:33:34 UTC
[Site]
Hi guys,
I guess this mail is much more targeting Ersin, but may be someone lese can
help.
Justen Stepka, from Atlassian (ya know, the company which product are just,
well, incredibly cool) has suggested that we should allow users to add
comments on the site's pages. This is just smart. Now, the question is : how
do we do that ?
We currently have this little grey icon on the right top of each page, it
would be a good idea to add another icon for comments, but more visible. And
also the same icon at the end of each page. I guess the template must be
changed. The comments should not be shown entirely on the resultant page,
but folded, to avoid having giant pages.
If we have those little 'comment' icons on our page will help a lot to
improve the site : we are 80% not english natives, so the text in those
pages migth be seen as pidgin to english natives.
wdyt ?
--
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: [Site]
Posted by Alex Karasulu <ak...@apache.org>.
Sure but I don't think confluence can do that :).
Alex
On 3/20/07, Emmanuel Lecharny <el...@gmail.com> wrote:
>
> I suggest that when a damn spammer tries to add a comment on one of our
> beautiful pages, he just receives a bowl of burning oil on his b*lls.
>
> wdyt ?
>
> On 3/20/07, Alex Karasulu <ak...@apache.org> wrote:
> >
> > I really liked this idea. I understand the head aches tho so this might
> > not be so easy or even worth doing.
> >
> > Oh another thing to worry about are those darn spammers. We need to
> > find a way to prevent that which becomes impossible when not locking things
> > down. :(
> >
> > Oye ve! This might just be one of those features not worth the labor to
> > have.
> >
> > Alex
> >
> > On 3/19/07, Ersin Er < ersin.er@gmail.com> wrote:
> > >
> > > On 3/19/07, Emmanuel Lecharny < elecharny@gmail.com> wrote:
> > > > Ersin, I see your point.
> > > >
> > > > What about asking Atlassian about the best way to do that? Maybe
> > > Justen can
> > > > help us (he suggested to add a way to comment pages, so may be he
> > > knows how
> > > > to do it ?)
> > >
> > > Confluence normally supports comments, as you may already know. But
> > > our theme just does not display them. We can change the theme to show
> > > the comments on each page. But the license problem still exists.
> > >
> > > >
> > > > On 3/19/07, Ersin Er <er...@gmail.com> wrote:
> > > > > On 3/19/07, Emmanuel Lecharny < elecharny@gmail.com > wrote:
> > > > > > Hi guys,
> > > > > >
> > > > > > I guess this mail is much more targeting Ersin, but may be
> > > someone lese
> > > > can
> > > > > > help.
> > > > > >
> > > > > > Justen Stepka, from Atlassian (ya know, the company which
> > > product are
> > > > just,
> > > > > > well, incredibly cool) has suggested that we should allow users
> > > to add
> > > > > > comments on the site's pages. This is just smart. Now, the
> > > question is :
> > > > how
> > > > > > do we do that ?
> > > > >
> > > > > This is not a new idea. We cannot do that (well under some
> > > conditions
> > > > > may be possible). Because, the site content is actually the
> > > > > documentation and it's (or it'll be) distributed with the released
> > >
> > > > > products. Components of the released products should all be
> > > committed
> > > > > (or contributed) by people who signed the appropriate Apache
> > > license.
> > > > >
> > > > > This is stated at http://cwiki.apache.org/CWIKI as:
> > > > >
> > > > > "Some Spaces are being used to create the Project documentation.
> > > > > Editing access to such Spaces might be restricted to Project
> > > > > committers or individuals who have filed a Contributor's License
> > > > > Agreement with the ASF."
> > > > >
> > > > > > We currently have this little grey icon on the right top of each
> > > page,
> > > > it
> > > > > > would be a good idea to add another icon for comments, but more
> > > visible.
> > > > And
> > > > > > also the same icon at the end of each page. I guess the template
> > > must be
> > > > > > changed. The comments should not be shown entirely on the
> > > resultant
> > > > page,
> > > > > > but folded, to avoid having giant pages.
> > > > > >
> > > > > > If we have those little 'comment' icons on our page will help a
> > > lot to
> > > > > > improve the site : we are 80% not english natives, so the text
> > > in those
> > > > > > pages migth be seen as pidgin to english natives.
> > > > >
> > > > > We may allow comments, but we should remove them when distributing
> > > the
> > > > > documentation.
> > > > >
> > > > > > wdyt ?
> > > > >
> > > > > Of course we should decide on an appropriate solution but it's not
> > > that
> > > > obvious.
> > > > >
> > > > > > --
> > > > > > Cordialement,
> > > > > > Emmanuel Lécharny
> > > > > > www.iktek.com
> > > > >
> > > > >
> > > > > --
> > > > > Ersin
> > > > >
> > > >
> > > >
> > > >
> > > > --
> > > >
> > > > Cordialement,
> > > > Emmanuel Lécharny
> > > > www.iktek.com
> > >
> > >
> > > --
> > > Ersin
> > >
> >
> >
>
>
> --
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com
>
Re: [Site]
Posted by Ole Ersoy <ol...@gmail.com>.
Yeah - I think that's how it works in most other places.
I asked the EMF team about contributions a while back, and was told that
as long as it goes in Bugzilla, it is assumed that it is
a contribution. So I imagine the same thing applies for JIRA for us,
and that JIRA takes care of off IP issues.
Emmanuel Lecharny wrote:
>
>
> On 3/20/07, *Ole Ersoy* <ole.ersoy@gmail.com
> <ma...@gmail.com>> wrote:
>
> Yeah! Lets talk to Atlassian about implementing this!!
>
>
> Beside the BurningOilPlugin, my opinion is that we can accept direct
> comments from logged users (you must be logged to add comments),
> without asking for CLAs.
>
> For people submitting patches, the best would be to send them a lail
> telling them to submit the patch via JIRA(thus we won't have anymore
> IP issues)
>
> wdyt ?
> --
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com <http://www.iktek.com>
Re: [Site]
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 3/20/07, Ole Ersoy <ol...@gmail.com> wrote:
>
> Yeah! Lets talk to Atlassian about implementing this!!
>
Beside the BurningOilPlugin, my opinion is that we can accept direct
comments from logged users (you must be logged to add comments), without
asking for CLAs.
For people submitting patches, the best would be to send them a lail telling
them to submit the patch via JIRA(thus we won't have anymore IP issues)
wdyt ?
--
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: [Site]
Posted by Ole Ersoy <ol...@gmail.com>.
Yeah! Lets talk to Atlassian about implementing this!!
Atlassian New Features:
Burning Oil on B@lls for Spam
Smack in the right nut for miss spelling
etc.
Hmmm - On a lot of the wiki's I just create an account and I can add
markup to the pages.
I'm thinking this is one of those very quickly self policed type things.
If someone adds spam, someone else takes it down very quickly, and the
domain from which the spam
came from is black listed.
Or
Someone creates a documentation patch via the Atlassian editor
The patch gets submitted to someone in our team
Reviewed
Applied.
So the patch is only applied locally in the users account (Appearing as
if others can see it too, until reviewed),
then once reviewed others can see it.
Emmanuel Lecharny wrote:
> I suggest that when a damn spammer tries to add a comment on one of
> our beautiful pages, he just receives a bowl of burning oil on his b*lls.
>
> wdyt ?
>
> On 3/20/07, * Alex Karasulu* <akarasulu@apache.org
> <ma...@apache.org>> wrote:
>
> I really liked this idea. I understand the head aches tho so this
> might not be so easy or even worth doing.
>
> Oh another thing to worry about are those darn spammers. We need
> to find a way to prevent that which becomes impossible when not
> locking things down. :(
>
> Oye ve! This might just be one of those features not worth the
> labor to have.
>
> Alex
>
>
> On 3/19/07, * Ersin Er* < ersin.er@gmail.com
> <ma...@gmail.com>> wrote:
>
> On 3/19/07, Emmanuel Lecharny < elecharny@gmail.com
> <ma...@gmail.com>> wrote:
> > Ersin, I see your point.
> >
> > What about asking Atlassian about the best way to do that?
> Maybe Justen can
> > help us (he suggested to add a way to comment pages, so may
> be he knows how
> > to do it ?)
>
> Confluence normally supports comments, as you may already
> know. But
> our theme just does not display them. We can change the theme
> to show
> the comments on each page. But the license problem still exists.
>
> >
> > On 3/19/07, Ersin Er <ersin.er@gmail.com
> <ma...@gmail.com>> wrote:
> > > On 3/19/07, Emmanuel Lecharny < elecharny@gmail.com
> <ma...@gmail.com> > wrote:
> > > > Hi guys,
> > > >
> > > > I guess this mail is much more targeting Ersin, but may
> be someone lese
> > can
> > > > help.
> > > >
> > > > Justen Stepka, from Atlassian (ya know, the company which
> product are
> > just,
> > > > well, incredibly cool) has suggested that we should allow
> users to add
> > > > comments on the site's pages. This is just smart. Now,
> the question is :
> > how
> > > > do we do that ?
> > >
> > > This is not a new idea. We cannot do that (well under some
> conditions
> > > may be possible). Because, the site content is actually the
> > > documentation and it's (or it'll be) distributed with the
> released
> > > products. Components of the released products should all be
> committed
> > > (or contributed) by people who signed the appropriate
> Apache license.
> > >
> > > This is stated at http://cwiki.apache.org/CWIKI as:
> > >
> > > "Some Spaces are being used to create the Project
> documentation.
> > > Editing access to such Spaces might be restricted to Project
> > > committers or individuals who have filed a Contributor's
> License
> > > Agreement with the ASF."
> > >
> > > > We currently have this little grey icon on the right top
> of each page,
> > it
> > > > would be a good idea to add another icon for comments,
> but more visible.
> > And
> > > > also the same icon at the end of each page. I guess the
> template must be
> > > > changed. The comments should not be shown entirely on the
> resultant
> > page,
> > > > but folded, to avoid having giant pages.
> > > >
> > > > If we have those little 'comment' icons on our page will
> help a lot to
> > > > improve the site : we are 80% not english natives, so the
> text in those
> > > > pages migth be seen as pidgin to english natives.
> > >
> > > We may allow comments, but we should remove them when
> distributing the
> > > documentation.
> > >
> > > > wdyt ?
> > >
> > > Of course we should decide on an appropriate solution but
> it's not that
> > obvious.
> > >
> > > > --
> > > > Cordialement,
> > > > Emmanuel Lécharny
> > > > www.iktek.com <http://www.iktek.com>
> > >
> > >
> > > --
> > > Ersin
> > >
> >
> >
> >
> > --
> >
> > Cordialement,
> > Emmanuel Lécharny
> > www.iktek.com <http://www.iktek.com>
>
>
> --
> Ersin
>
>
>
>
>
> --
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com <http://www.iktek.com>
Re: [Site]
Posted by Emmanuel Lecharny <el...@gmail.com>.
I suggest that when a damn spammer tries to add a comment on one of our
beautiful pages, he just receives a bowl of burning oil on his b*lls.
wdyt ?
On 3/20/07, Alex Karasulu <ak...@apache.org> wrote:
>
> I really liked this idea. I understand the head aches tho so this might
> not be so easy or even worth doing.
>
> Oh another thing to worry about are those darn spammers. We need to find
> a way to prevent that which becomes impossible when not locking things down.
> :(
>
> Oye ve! This might just be one of those features not worth the labor to
> have.
>
> Alex
>
> On 3/19/07, Ersin Er < ersin.er@gmail.com> wrote:
> >
> > On 3/19/07, Emmanuel Lecharny < elecharny@gmail.com> wrote:
> > > Ersin, I see your point.
> > >
> > > What about asking Atlassian about the best way to do that? Maybe
> > Justen can
> > > help us (he suggested to add a way to comment pages, so may be he
> > knows how
> > > to do it ?)
> >
> > Confluence normally supports comments, as you may already know. But
> > our theme just does not display them. We can change the theme to show
> > the comments on each page. But the license problem still exists.
> >
> > >
> > > On 3/19/07, Ersin Er <er...@gmail.com> wrote:
> > > > On 3/19/07, Emmanuel Lecharny <elecharny@gmail.com > wrote:
> > > > > Hi guys,
> > > > >
> > > > > I guess this mail is much more targeting Ersin, but may be someone
> > lese
> > > can
> > > > > help.
> > > > >
> > > > > Justen Stepka, from Atlassian (ya know, the company which product
> > are
> > > just,
> > > > > well, incredibly cool) has suggested that we should allow users to
> > add
> > > > > comments on the site's pages. This is just smart. Now, the
> > question is :
> > > how
> > > > > do we do that ?
> > > >
> > > > This is not a new idea. We cannot do that (well under some
> > conditions
> > > > may be possible). Because, the site content is actually the
> > > > documentation and it's (or it'll be) distributed with the released
> > > > products. Components of the released products should all be
> > committed
> > > > (or contributed) by people who signed the appropriate Apache
> > license.
> > > >
> > > > This is stated at http://cwiki.apache.org/CWIKI as:
> > > >
> > > > "Some Spaces are being used to create the Project documentation.
> > > > Editing access to such Spaces might be restricted to Project
> > > > committers or individuals who have filed a Contributor's License
> > > > Agreement with the ASF."
> > > >
> > > > > We currently have this little grey icon on the right top of each
> > page,
> > > it
> > > > > would be a good idea to add another icon for comments, but more
> > visible.
> > > And
> > > > > also the same icon at the end of each page. I guess the template
> > must be
> > > > > changed. The comments should not be shown entirely on the
> > resultant
> > > page,
> > > > > but folded, to avoid having giant pages.
> > > > >
> > > > > If we have those little 'comment' icons on our page will help a
> > lot to
> > > > > improve the site : we are 80% not english natives, so the text in
> > those
> > > > > pages migth be seen as pidgin to english natives.
> > > >
> > > > We may allow comments, but we should remove them when distributing
> > the
> > > > documentation.
> > > >
> > > > > wdyt ?
> > > >
> > > > Of course we should decide on an appropriate solution but it's not
> > that
> > > obvious.
> > > >
> > > > > --
> > > > > Cordialement,
> > > > > Emmanuel Lécharny
> > > > > www.iktek.com
> > > >
> > > >
> > > > --
> > > > Ersin
> > > >
> > >
> > >
> > >
> > > --
> > >
> > > Cordialement,
> > > Emmanuel Lécharny
> > > www.iktek.com
> >
> >
> > --
> > Ersin
> >
>
>
--
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: [Site]
Posted by Alex Karasulu <ak...@apache.org>.
I really liked this idea. I understand the head aches tho so this might not
be so easy or even worth doing.
Oh another thing to worry about are those darn spammers. We need to find a
way to prevent that which becomes impossible when not locking things down.
:(
Oye ve! This might just be one of those features not worth the labor to
have.
Alex
On 3/19/07, Ersin Er <er...@gmail.com> wrote:
>
> On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> > Ersin, I see your point.
> >
> > What about asking Atlassian about the best way to do that? Maybe Justen
> can
> > help us (he suggested to add a way to comment pages, so may be he knows
> how
> > to do it ?)
>
> Confluence normally supports comments, as you may already know. But
> our theme just does not display them. We can change the theme to show
> the comments on each page. But the license problem still exists.
>
> >
> > On 3/19/07, Ersin Er <er...@gmail.com> wrote:
> > > On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> > > > Hi guys,
> > > >
> > > > I guess this mail is much more targeting Ersin, but may be someone
> lese
> > can
> > > > help.
> > > >
> > > > Justen Stepka, from Atlassian (ya know, the company which product
> are
> > just,
> > > > well, incredibly cool) has suggested that we should allow users to
> add
> > > > comments on the site's pages. This is just smart. Now, the question
> is :
> > how
> > > > do we do that ?
> > >
> > > This is not a new idea. We cannot do that (well under some conditions
> > > may be possible). Because, the site content is actually the
> > > documentation and it's (or it'll be) distributed with the released
> > > products. Components of the released products should all be committed
> > > (or contributed) by people who signed the appropriate Apache license.
> > >
> > > This is stated at http://cwiki.apache.org/CWIKI as:
> > >
> > > "Some Spaces are being used to create the Project documentation.
> > > Editing access to such Spaces might be restricted to Project
> > > committers or individuals who have filed a Contributor's License
> > > Agreement with the ASF."
> > >
> > > > We currently have this little grey icon on the right top of each
> page,
> > it
> > > > would be a good idea to add another icon for comments, but more
> visible.
> > And
> > > > also the same icon at the end of each page. I guess the template
> must be
> > > > changed. The comments should not be shown entirely on the resultant
> > page,
> > > > but folded, to avoid having giant pages.
> > > >
> > > > If we have those little 'comment' icons on our page will help a lot
> to
> > > > improve the site : we are 80% not english natives, so the text in
> those
> > > > pages migth be seen as pidgin to english natives.
> > >
> > > We may allow comments, but we should remove them when distributing the
> > > documentation.
> > >
> > > > wdyt ?
> > >
> > > Of course we should decide on an appropriate solution but it's not
> that
> > obvious.
> > >
> > > > --
> > > > Cordialement,
> > > > Emmanuel Lécharny
> > > > www.iktek.com
> > >
> > >
> > > --
> > > Ersin
> > >
> >
> >
> >
> > --
> >
> > Cordialement,
> > Emmanuel Lécharny
> > www.iktek.com
>
>
> --
> Ersin
>
Re: [Site]
Posted by Ersin Er <er...@gmail.com>.
On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> Ersin, I see your point.
>
> What about asking Atlassian about the best way to do that? Maybe Justen can
> help us (he suggested to add a way to comment pages, so may be he knows how
> to do it ?)
Confluence normally supports comments, as you may already know. But
our theme just does not display them. We can change the theme to show
the comments on each page. But the license problem still exists.
>
> On 3/19/07, Ersin Er <er...@gmail.com> wrote:
> > On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> > > Hi guys,
> > >
> > > I guess this mail is much more targeting Ersin, but may be someone lese
> can
> > > help.
> > >
> > > Justen Stepka, from Atlassian (ya know, the company which product are
> just,
> > > well, incredibly cool) has suggested that we should allow users to add
> > > comments on the site's pages. This is just smart. Now, the question is :
> how
> > > do we do that ?
> >
> > This is not a new idea. We cannot do that (well under some conditions
> > may be possible). Because, the site content is actually the
> > documentation and it's (or it'll be) distributed with the released
> > products. Components of the released products should all be committed
> > (or contributed) by people who signed the appropriate Apache license.
> >
> > This is stated at http://cwiki.apache.org/CWIKI as:
> >
> > "Some Spaces are being used to create the Project documentation.
> > Editing access to such Spaces might be restricted to Project
> > committers or individuals who have filed a Contributor's License
> > Agreement with the ASF."
> >
> > > We currently have this little grey icon on the right top of each page,
> it
> > > would be a good idea to add another icon for comments, but more visible.
> And
> > > also the same icon at the end of each page. I guess the template must be
> > > changed. The comments should not be shown entirely on the resultant
> page,
> > > but folded, to avoid having giant pages.
> > >
> > > If we have those little 'comment' icons on our page will help a lot to
> > > improve the site : we are 80% not english natives, so the text in those
> > > pages migth be seen as pidgin to english natives.
> >
> > We may allow comments, but we should remove them when distributing the
> > documentation.
> >
> > > wdyt ?
> >
> > Of course we should decide on an appropriate solution but it's not that
> obvious.
> >
> > > --
> > > Cordialement,
> > > Emmanuel Lécharny
> > > www.iktek.com
> >
> >
> > --
> > Ersin
> >
>
>
>
> --
>
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com
--
Ersin
Re: [Site]
Posted by Emmanuel Lecharny <el...@gmail.com>.
Ersin, I see your point.
What about asking Atlassian about the best way to do that? Maybe Justen can
help us (he suggested to add a way to comment pages, so may be he knows how
to do it ?)
On 3/19/07, Ersin Er <er...@gmail.com> wrote:
>
> On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> > Hi guys,
> >
> > I guess this mail is much more targeting Ersin, but may be someone lese
> can
> > help.
> >
> > Justen Stepka, from Atlassian (ya know, the company which product are
> just,
> > well, incredibly cool) has suggested that we should allow users to add
> > comments on the site's pages. This is just smart. Now, the question is :
> how
> > do we do that ?
>
> This is not a new idea. We cannot do that (well under some conditions
> may be possible). Because, the site content is actually the
> documentation and it's (or it'll be) distributed with the released
> products. Components of the released products should all be committed
> (or contributed) by people who signed the appropriate Apache license.
>
> This is stated at http://cwiki.apache.org/CWIKI as:
>
> "Some Spaces are being used to create the Project documentation.
> Editing access to such Spaces might be restricted to Project
> committers or individuals who have filed a Contributor's License
> Agreement with the ASF."
>
> > We currently have this little grey icon on the right top of each page,
> it
> > would be a good idea to add another icon for comments, but more visible.
> And
> > also the same icon at the end of each page. I guess the template must be
> > changed. The comments should not be shown entirely on the resultant
> page,
> > but folded, to avoid having giant pages.
> >
> > If we have those little 'comment' icons on our page will help a lot to
> > improve the site : we are 80% not english natives, so the text in those
> > pages migth be seen as pidgin to english natives.
>
> We may allow comments, but we should remove them when distributing the
> documentation.
>
> > wdyt ?
>
> Of course we should decide on an appropriate solution but it's not that
> obvious.
>
> > --
> > Cordialement,
> > Emmanuel Lécharny
> > www.iktek.com
>
>
> --
> Ersin
>
--
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: [Site]
Posted by Emmanuel Lecharny <el...@gmail.com>.
Ole Ersoy a écrit :
> Ah - Cool - WRT intellectual property - when the user gets an account
> - can't they just click on something
> that says that they contribution is Apache Licensed, and that they
> certify that blah blah blah legal stuff...WRT IP stuff
> is all cool?
Sadly enough, no...
Re: [Site]
Posted by Ole Ersoy <ol...@gmail.com>.
Ah - Cool - WRT intellectual property - when the user gets an account -
can't they just click on something
that says that they contribution is Apache Licensed, and that they
certify that blah blah blah legal stuff...WRT IP stuff
is all cool?
Emmanuel Lecharny wrote:
> Man, this is exactly why we are using Confluence : it offers all the
> items you listed.
>
> The only problem is that we have to be careful with IP.
>
> Emmanuel
>
> On 3/19/07, * Ole Ersoy* <ole.ersoy@gmail.com
> <ma...@gmail.com>> wrote:
>
> Hey Ersin, Emmanuel,
>
> I love the idea of having users be able to add comments directly into
> the documentation.
>
> I also like having professional looking "Uncommmented and
> clean/finalized" documentation like the site now has.
>
> So from a process perspective it sounds like we are thinking that
> there
> is a "Work in progress" documentation
> area, that feeds into a review queue, where whoever is responsible for
> that page/pages
> reviews the commit and patches the corresponding site documentation.
>
> This should be really simple like a link arrives in email per the
> comment to the review. The reviewer clicks
> on the link, reviews, makes a few adjustments maybe, and then pushes
> another button, and the main site is updated.
>
> I also think the person who made the comment on a documentation page
> should get an email
> saying that the comment has been incorporated. That way they know
> where
> to look for their comment
> in the future in case they need it.
>
> I also think that the user should have an account, and that the system
> updates the users account "bookmarks" with the edit they committed.
>
> Summary:
> User: Provides comment (Via a button on the main finalized
> documentation
> page that opens commenting editor)
> System: Generates comment patch and sends to reviewer (Bugzilla type
> patch review display)
> Reviewer: Reviews and changes stuff (or just just clicks ok)
> System: Updates main site
> System: Sends email to user about commit to main documentation (And
> updates bookmarks - just to add a little sugar on top :-) )
>
> Cheers,
> - Ole
>
>
>
> Ersin Er wrote:
> > On 3/19/07, Emmanuel Lecharny <elecharny@gmail.com
> <ma...@gmail.com>> wrote:
> >> Hi guys,
> >>
> >> I guess this mail is much more targeting Ersin, but may be someone
> >> lese can
> >> help.
> >>
> >> Justen Stepka, from Atlassian (ya know, the company which
> product are
> >> just,
> >> well, incredibly cool) has suggested that we should allow users
> to add
> >> comments on the site's pages. This is just smart. Now, the question
> >> is : how
> >> do we do that ?
> >
> > This is not a new idea. We cannot do that (well under some
> conditions
> > may be possible). Because, the site content is actually the
> > documentation and it's (or it'll be) distributed with the released
> > products. Components of the released products should all be
> committed
> > (or contributed) by people who signed the appropriate Apache
> license.
> >
> > This is stated at http://cwiki.apache.org/CWIKI as:
> >
> > "Some Spaces are being used to create the Project documentation.
> > Editing access to such Spaces might be restricted to Project
> > committers or individuals who have filed a Contributor's License
> > Agreement with the ASF."
> >
> >> We currently have this little grey icon on the right top of each
> >> page, it
> >> would be a good idea to add another icon for comments, but more
> >> visible. And
> >> also the same icon at the end of each page. I guess the
> template must be
> >> changed. The comments should not be shown entirely on the
> resultant
> >> page,
> >> but folded, to avoid having giant pages.
> >>
> >> If we have those little 'comment' icons on our page will help a
> lot to
> >> improve the site : we are 80% not english natives, so the text
> in those
> >> pages migth be seen as pidgin to english natives.
> >
> > We may allow comments, but we should remove them when
> distributing the
> > documentation.
> >
> >> wdyt ?
> >
> > Of course we should decide on an appropriate solution but it's not
> > that obvious.
> >
> >> --
> >> Cordialement,
> >> Emmanuel Lécharny
> >> www.iktek.com <http://www.iktek.com>
> >
> >
>
>
>
>
> --
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com <http://www.iktek.com>
Re: [Site]
Posted by Emmanuel Lecharny <el...@gmail.com>.
Man, this is exactly why we are using Confluence : it offers all the items
you listed.
The only problem is that we have to be careful with IP.
Emmanuel
On 3/19/07, Ole Ersoy <ol...@gmail.com> wrote:
>
> Hey Ersin, Emmanuel,
>
> I love the idea of having users be able to add comments directly into
> the documentation.
>
> I also like having professional looking "Uncommmented and
> clean/finalized" documentation like the site now has.
>
> So from a process perspective it sounds like we are thinking that there
> is a "Work in progress" documentation
> area, that feeds into a review queue, where whoever is responsible for
> that page/pages
> reviews the commit and patches the corresponding site documentation.
>
> This should be really simple like a link arrives in email per the
> comment to the review. The reviewer clicks
> on the link, reviews, makes a few adjustments maybe, and then pushes
> another button, and the main site is updated.
>
> I also think the person who made the comment on a documentation page
> should get an email
> saying that the comment has been incorporated. That way they know where
> to look for their comment
> in the future in case they need it.
>
> I also think that the user should have an account, and that the system
> updates the users account "bookmarks" with the edit they committed.
>
> Summary:
> User: Provides comment (Via a button on the main finalized documentation
> page that opens commenting editor)
> System: Generates comment patch and sends to reviewer (Bugzilla type
> patch review display)
> Reviewer: Reviews and changes stuff (or just just clicks ok)
> System: Updates main site
> System: Sends email to user about commit to main documentation (And
> updates bookmarks - just to add a little sugar on top :-) )
>
> Cheers,
> - Ole
>
>
>
> Ersin Er wrote:
> > On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> >> Hi guys,
> >>
> >> I guess this mail is much more targeting Ersin, but may be someone
> >> lese can
> >> help.
> >>
> >> Justen Stepka, from Atlassian (ya know, the company which product are
> >> just,
> >> well, incredibly cool) has suggested that we should allow users to add
> >> comments on the site's pages. This is just smart. Now, the question
> >> is : how
> >> do we do that ?
> >
> > This is not a new idea. We cannot do that (well under some conditions
> > may be possible). Because, the site content is actually the
> > documentation and it's (or it'll be) distributed with the released
> > products. Components of the released products should all be committed
> > (or contributed) by people who signed the appropriate Apache license.
> >
> > This is stated at http://cwiki.apache.org/CWIKI as:
> >
> > "Some Spaces are being used to create the Project documentation.
> > Editing access to such Spaces might be restricted to Project
> > committers or individuals who have filed a Contributor's License
> > Agreement with the ASF."
> >
> >> We currently have this little grey icon on the right top of each
> >> page, it
> >> would be a good idea to add another icon for comments, but more
> >> visible. And
> >> also the same icon at the end of each page. I guess the template must
> be
> >> changed. The comments should not be shown entirely on the resultant
> >> page,
> >> but folded, to avoid having giant pages.
> >>
> >> If we have those little 'comment' icons on our page will help a lot to
> >> improve the site : we are 80% not english natives, so the text in those
> >> pages migth be seen as pidgin to english natives.
> >
> > We may allow comments, but we should remove them when distributing the
> > documentation.
> >
> >> wdyt ?
> >
> > Of course we should decide on an appropriate solution but it's not
> > that obvious.
> >
> >> --
> >> Cordialement,
> >> Emmanuel Lécharny
> >> www.iktek.com
> >
> >
>
>
--
Cordialement,
Emmanuel Lécharny
www.iktek.com
Re: [Site]
Posted by Ole Ersoy <ol...@gmail.com>.
Hey Ersin, Emmanuel,
I love the idea of having users be able to add comments directly into
the documentation.
I also like having professional looking "Uncommmented and
clean/finalized" documentation like the site now has.
So from a process perspective it sounds like we are thinking that there
is a "Work in progress" documentation
area, that feeds into a review queue, where whoever is responsible for
that page/pages
reviews the commit and patches the corresponding site documentation.
This should be really simple like a link arrives in email per the
comment to the review. The reviewer clicks
on the link, reviews, makes a few adjustments maybe, and then pushes
another button, and the main site is updated.
I also think the person who made the comment on a documentation page
should get an email
saying that the comment has been incorporated. That way they know where
to look for their comment
in the future in case they need it.
I also think that the user should have an account, and that the system
updates the users account "bookmarks" with the edit they committed.
Summary:
User: Provides comment (Via a button on the main finalized documentation
page that opens commenting editor)
System: Generates comment patch and sends to reviewer (Bugzilla type
patch review display)
Reviewer: Reviews and changes stuff (or just just clicks ok)
System: Updates main site
System: Sends email to user about commit to main documentation (And
updates bookmarks - just to add a little sugar on top :-) )
Cheers,
- Ole
Ersin Er wrote:
> On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
>> Hi guys,
>>
>> I guess this mail is much more targeting Ersin, but may be someone
>> lese can
>> help.
>>
>> Justen Stepka, from Atlassian (ya know, the company which product are
>> just,
>> well, incredibly cool) has suggested that we should allow users to add
>> comments on the site's pages. This is just smart. Now, the question
>> is : how
>> do we do that ?
>
> This is not a new idea. We cannot do that (well under some conditions
> may be possible). Because, the site content is actually the
> documentation and it's (or it'll be) distributed with the released
> products. Components of the released products should all be committed
> (or contributed) by people who signed the appropriate Apache license.
>
> This is stated at http://cwiki.apache.org/CWIKI as:
>
> "Some Spaces are being used to create the Project documentation.
> Editing access to such Spaces might be restricted to Project
> committers or individuals who have filed a Contributor's License
> Agreement with the ASF."
>
>> We currently have this little grey icon on the right top of each
>> page, it
>> would be a good idea to add another icon for comments, but more
>> visible. And
>> also the same icon at the end of each page. I guess the template must be
>> changed. The comments should not be shown entirely on the resultant
>> page,
>> but folded, to avoid having giant pages.
>>
>> If we have those little 'comment' icons on our page will help a lot to
>> improve the site : we are 80% not english natives, so the text in those
>> pages migth be seen as pidgin to english natives.
>
> We may allow comments, but we should remove them when distributing the
> documentation.
>
>> wdyt ?
>
> Of course we should decide on an appropriate solution but it's not
> that obvious.
>
>> --
>> Cordialement,
>> Emmanuel Lécharny
>> www.iktek.com
>
>
Re: [Site]
Posted by Ersin Er <er...@gmail.com>.
On 3/19/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> Hi guys,
>
> I guess this mail is much more targeting Ersin, but may be someone lese can
> help.
>
> Justen Stepka, from Atlassian (ya know, the company which product are just,
> well, incredibly cool) has suggested that we should allow users to add
> comments on the site's pages. This is just smart. Now, the question is : how
> do we do that ?
This is not a new idea. We cannot do that (well under some conditions
may be possible). Because, the site content is actually the
documentation and it's (or it'll be) distributed with the released
products. Components of the released products should all be committed
(or contributed) by people who signed the appropriate Apache license.
This is stated at http://cwiki.apache.org/CWIKI as:
"Some Spaces are being used to create the Project documentation.
Editing access to such Spaces might be restricted to Project
committers or individuals who have filed a Contributor's License
Agreement with the ASF."
> We currently have this little grey icon on the right top of each page, it
> would be a good idea to add another icon for comments, but more visible. And
> also the same icon at the end of each page. I guess the template must be
> changed. The comments should not be shown entirely on the resultant page,
> but folded, to avoid having giant pages.
>
> If we have those little 'comment' icons on our page will help a lot to
> improve the site : we are 80% not english natives, so the text in those
> pages migth be seen as pidgin to english natives.
We may allow comments, but we should remove them when distributing the
documentation.
> wdyt ?
Of course we should decide on an appropriate solution but it's not that obvious.
> --
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com
--
Ersin