Documentation contribution

[richard jackson <rd...@gmail.com>]

Just wondering if there is some style guideline for user contributed
documentation. Or better yet if there is a Wiki for Felix where I can just
go and add it. What I'm thinking about adding is a document similar to this
one http://felix.apache.org/site/integration-of-felix-inside-eclipse.htmlbut
for Netbeans.

Thanks
Richard Jackson

Re: Documentation contribution

[richard jackson <rd...@gmail.com>]

On Sat, Aug 2, 2008 at 8:04 AM, Richard S. Hall <he...@ungoverned.org>wrote:

> richard jackson wrote:
>
>> Just wondering if there is some style guideline for user contributed
>> documentation. Or better yet if there is a Wiki for Felix where I can just
>> go and add it. What I'm thinking about adding is a document similar to
>> this
>> one
>> http://felix.apache.org/site/integration-of-felix-inside-eclipse.htmlbut
>> for Netbeans.
>>
>>
>
> That would be great to have such a document. I think you can add it
> directly as a comment to our wiki or you could just create a document (such
> as in OpenOffice) and attach that to a JIRA issue and we could convert it,
> just keep the document formatting simple to ease conversion.
>
Did not know that the comments where flexible enough to do the entire
document in. I will check that out. Or I will end up doing it in OpenOffice.



>
> The wiki is generally write accessible to everyone, except for comments.
> However, if you make a contribution and wish to continue to contribute more
> documentation or improvements to existing documentation, you will likely be
> able to gain write access via your contributions.
>
> Thanks a lot and good.
>
> -> richard
>
>  Thanks
>> Richard Jackson
>>
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
> For additional commands, e-mail: users-help@felix.apache.org
>
>

Re: Documentation contribution

["Richard S. Hall" <he...@ungoverned.org>]

Richard S. Hall wrote:
> richard jackson wrote:
>> Just wondering if there is some style guideline for user contributed
>> documentation. Or better yet if there is a Wiki for Felix where I can 
>> just
>> go and add it. What I'm thinking about adding is a document similar 
>> to this
>> one 
>> http://felix.apache.org/site/integration-of-felix-inside-eclipse.htmlbut
>> for Netbeans.
>>   
>
> That would be great to have such a document. I think you can add it 
> directly as a comment to our wiki or you could just create a document 
> (such as in OpenOffice) and attach that to a JIRA issue and we could 
> convert it, just keep the document formatting simple to ease conversion.
>
> The wiki is generally write accessible to everyone, except for 
> comments. However, if you make a contribution and wish to continue to 
> contribute more documentation or improvements to existing 
> documentation, you will likely be able to gain write access via your 
> contributions.
>
> Thanks a lot and good.

Sorry, that should have said "good luck"...

-> richard

>
> -> richard
>
>> Thanks
>> Richard Jackson
>>
>>   
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
> For additional commands, e-mail: users-help@felix.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

[Felix Meschberger <fm...@gmail.com>]

Hi,

Richard S. Hall schrieb:
> Felix Meschberger wrote:
>> Hi,
>>
>> Richard S. Hall schrieb:
>>> Marcel Offermans wrote:
>>>> A bit off-topic, strictly spoken the website is now generated by a 
>>>> plugin that uses the Confluence user "autoexport" to determine 
>>>> what's visible for export. I have not tried this, but if you would 
>>>> create pages that are not accessible to that user (perhaps make sure 
>>>> all new content by default is not) then you can actually use the 
>>>> confluence rights management system to "tag" pages that can be 
>>>> exported to the website. I'm not sure if that's worth the trouble 
>>>> though, as formally every time you tag something that has 
>>>> contributions by users that don't have a CLA on file would still 
>>>> need to go through some form of official process...
>>>
>>> Yeah, I don't know either, but it would be nice if we could open up 
>>> our wiki a little bit more...
>>
>> Sounds a bit hacky to me.
>>
>> Why not just get a public wiki ? This is what we have done in Sling 
>> (and other projects are also doing): ${project}xSITE is the site 
>> source writable only to commiters and ${project} is the public wiki.
> 
> I am not sure it will help us if we cannot use the public site to 
> generate our web page...I wouldn't want two separate wikis with 
> different sets of information on them...

Agreed. My answer would be, that the general public could enter 
information into the public wiki (as another path in addition to JIRA 
and comments) and we may decide to migrate this in some form or another 
to the public site over time (maybe we would still need the CLA of the 
original poster on file).

Regards
Felix

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

["Richard S. Hall" <he...@ungoverned.org>]

Felix Meschberger wrote:
> Hi,
>
> Richard S. Hall schrieb:
>> Marcel Offermans wrote:
>>> A bit off-topic, strictly spoken the website is now generated by a 
>>> plugin that uses the Confluence user "autoexport" to determine 
>>> what's visible for export. I have not tried this, but if you would 
>>> create pages that are not accessible to that user (perhaps make sure 
>>> all new content by default is not) then you can actually use the 
>>> confluence rights management system to "tag" pages that can be 
>>> exported to the website. I'm not sure if that's worth the trouble 
>>> though, as formally every time you tag something that has 
>>> contributions by users that don't have a CLA on file would still 
>>> need to go through some form of official process...
>>
>> Yeah, I don't know either, but it would be nice if we could open up 
>> our wiki a little bit more...
>
> Sounds a bit hacky to me.
>
> Why not just get a public wiki ? This is what we have done in Sling 
> (and other projects are also doing): ${project}xSITE is the site 
> source writable only to commiters and ${project} is the public wiki.

I am not sure it will help us if we cannot use the public site to 
generate our web page...I wouldn't want two separate wikis with 
different sets of information on them...

-> richard

>
> Regards
> Felix
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
> For additional commands, e-mail: users-help@felix.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

[Felix Meschberger <fm...@gmail.com>]

Hi,

Richard S. Hall schrieb:
> Marcel Offermans wrote:
>> A bit off-topic, strictly spoken the website is now generated by a 
>> plugin that uses the Confluence user "autoexport" to determine what's 
>> visible for export. I have not tried this, but if you would create 
>> pages that are not accessible to that user (perhaps make sure all new 
>> content by default is not) then you can actually use the confluence 
>> rights management system to "tag" pages that can be exported to the 
>> website. I'm not sure if that's worth the trouble though, as formally 
>> every time you tag something that has contributions by users that 
>> don't have a CLA on file would still need to go through some form of 
>> official process...
> 
> Yeah, I don't know either, but it would be nice if we could open up our 
> wiki a little bit more...

Sounds a bit hacky to me.

Why not just get a public wiki ? This is what we have done in Sling (and 
other projects are also doing): ${project}xSITE is the site source 
writable only to commiters and ${project} is the public wiki.

Regards
Felix

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

["Richard S. Hall" <he...@ungoverned.org>]

Marcel Offermans wrote:
> On Aug 2, 2008, at 15:04 , Richard S. Hall wrote:
>
>> The wiki is generally write accessible to everyone, except for comments.

D'oh! That should have said "...is generally NOT accessible to everyone, 
except for comments."

But as Marcel points out, you need to be logged in to comment.

Sorry. I am tired. ;-)

> Well, no, if you're not logged in, you can't modify anything.
> If you are logged in as a registered user, you can ONLY write comments 
> (that will only be visible within the wiki, and not on the generated 
> website).
> If you are a committer (CLA on file) you can be added to a special 
> user group in the wiki, which gives you write and modify access.
>
> A bit off-topic, strictly spoken the website is now generated by a 
> plugin that uses the Confluence user "autoexport" to determine what's 
> visible for export. I have not tried this, but if you would create 
> pages that are not accessible to that user (perhaps make sure all new 
> content by default is not) then you can actually use the confluence 
> rights management system to "tag" pages that can be exported to the 
> website. I'm not sure if that's worth the trouble though, as formally 
> every time you tag something that has contributions by users that 
> don't have a CLA on file would still need to go through some form of 
> official process...

Yeah, I don't know either, but it would be nice if we could open up our 
wiki a little bit more...

-> richard

>
> Greetings, Marcel
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
> For additional commands, e-mail: users-help@felix.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

[Marcel Offermans <ma...@luminis.nl>]

On Aug 2, 2008, at 15:04 , Richard S. Hall wrote:

> The wiki is generally write accessible to everyone, except for  
> comments.

Well, no, if you're not logged in, you can't modify anything.
If you are logged in as a registered user, you can ONLY write comments  
(that will only be visible within the wiki, and not on the generated  
website).
If you are a committer (CLA on file) you can be added to a special  
user group in the wiki, which gives you write and modify access.

A bit off-topic, strictly spoken the website is now generated by a  
plugin that uses the Confluence user "autoexport" to determine what's  
visible for export. I have not tried this, but if you would create  
pages that are not accessible to that user (perhaps make sure all new  
content by default is not) then you can actually use the confluence  
rights management system to "tag" pages that can be exported to the  
website. I'm not sure if that's worth the trouble though, as formally  
every time you tag something that has contributions by users that  
don't have a CLA on file would still need to go through some form of  
official process...

Greetings, Marcel


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

["Richard S. Hall" <he...@ungoverned.org>]

richard jackson wrote:
> Just wondering if there is some style guideline for user contributed
> documentation. Or better yet if there is a Wiki for Felix where I can just
> go and add it. What I'm thinking about adding is a document similar to this
> one http://felix.apache.org/site/integration-of-felix-inside-eclipse.htmlbut
> for Netbeans.
>   

That would be great to have such a document. I think you can add it 
directly as a comment to our wiki or you could just create a document 
(such as in OpenOffice) and attach that to a JIRA issue and we could 
convert it, just keep the document formatting simple to ease conversion.

The wiki is generally write accessible to everyone, except for comments. 
However, if you make a contribution and wish to continue to contribute 
more documentation or improvements to existing documentation, you will 
likely be able to gain write access via your contributions.

Thanks a lot and good.

-> richard

> Thanks
> Richard Jackson
>
>   

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org

Re: Documentation contribution

[Marcel Offermans <ma...@luminis.nl>]

On Aug 2, 2008, at 6:31 , richard jackson wrote:

> Just wondering if there is some style guideline for user contributed
> documentation. Or better yet if there is a Wiki for Felix where I  
> can just
> go and add it.

Actually, the whole Felix website is automatically generated from a  
wiki. Take a look here for a good starting point:
http://cwiki.apache.org/confluence/display/FELIX/wiki

You might also want to have a quick look at:
http://felix.apache.org/site/contributing.html

> What I'm thinking about adding is a document similar to this
> one http://felix.apache.org/site/integration-of-felix-inside-eclipse.htmlbut
> for Netbeans.

That sounds great! As soon as you sign up for the wiki, you will be  
allowed to comment on any existing page. You actually need to be a  
committer to create and edit pages. We have to require that because we  
ship (part of) our website with our releases and Apache laws require  
us to make sure that everything we ship is created by "someone with a  
CLA on file" (which is my interpretation of all the legal speak, I'm a  
developer, not a lawyer ;) ).

Anyway, from the links above you can see you have two options:
a) write a document and add it to a JIRA issue to contribute it;
b) comment on some existing wiki page (using the one you use as an  
example above would make sense).

Greetings, Marcel


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@felix.apache.org
For additional commands, e-mail: users-help@felix.apache.org