Re: Graduation? - Confluence Wiki option

[William Hayes <Wi...@biogenidec.com>]

+1 Regarding using Confluence Wiki for support documentation, knowledge
sharing.  

Setting up a wiki for documentation would help a lot - currently the
project is running the website via SVN as far as I can tell, but more
people (including me) will find Confluence more approachable for
documentation.  With their versioning, you can revert back to a previous
version of the documentation if needed, plus you should be able to have an
Official Wiki Rave Space with limited membership and a User-supported Wiki
space with more open membership.

One thing I meant to ask about is how I upload Screenstep tutorials - in
confluence it's trivial.  A Screenstep tutorial (HTML-based) is
essentially a website with a web page, CSS files and image files, but they
have a one-step publishing option into Confluence (or blog sites).

PS - if you don't already know about Screensteps and you ever create
documentation or need to show someone how to do something occasionally -
you owe it to yourself to learn about it.  It even makes creating
screenshot-based documentation fun.  (Alas, I have no investment or
business affiliation with Blue Mango the company that produces it).



On 1/16/12 10:56 AM, "Ross Gardler" <rg...@opendirective.com> wrote:

>On 16 January 2012 15:52, Franklin, Matthew B. <mf...@mitre.org>
>wrote:
>
>...
>
>> As a first step, I took a look at the remaining work items on our status
>> page that need to be completed and updated the dates for the ones we
>>have
>> finished, but had not recorded.  That leaves us with the following list
>>of
>> items:
>>
>> * Make sure that the requested project name does not already exist and
>> check www.nameprotect.com to be sure that the name is not already
>> trademarked for an existing software product.
>
>Important
>
>> * If request from anywhere to become a stand-alone PMC, then assess the
>> fit with the ASF, and create the lists and modules under the incubator
>> address/module names if accepted.
>
>Important
>
>> * Ask infrastructure to set up wiki (Confluence, Moin).
>
>Does the project want one? Not needed so far and not needed for
>graduation. You can always ask for one as a TLP if you change your
>minds.
>
>> * Check and make sure that the files that have been donated have been
>> updated to reflect the new ASF copyright.
>
>Already done, surely?
>
>Ross
>

Re: Graduation? - Confluence Wiki option

[Ate Douma <at...@douma.nu>]

On 01/16/2012 05:31 PM, William Hayes wrote:
> +1 Regarding using Confluence Wiki for support documentation, knowledge
> sharing.

I think it is good to mention that the usage and support of *Confluence* at 
Apache is less than it was before. Quite a few projects are actually migrating 
away from Confluence to the new Apache CMS because maintenance and uptime of 
Confluence is or was not very good, nor the mapping to and integration with the 
main project website.

I'm not strongly against using Confluence, if the community so desires, but be 
aware that Apache infra might be less inclined...


>
> Setting up a wiki for documentation would help a lot - currently the
> project is running the website via SVN as far as I can tell, but more
> people (including me) will find Confluence more approachable for
> documentation.  With their versioning, you can revert back to a previous
> version of the documentation if needed, plus you should be able to have an
> Official Wiki Rave Space with limited membership and a User-supported Wiki
> space with more open membership.
>
> One thing I meant to ask about is how I upload Screenstep tutorials - in
> confluence it's trivial.  A Screenstep tutorial (HTML-based) is
> essentially a website with a web page, CSS files and image files, but they
> have a one-step publishing option into Confluence (or blog sites).
>
> PS - if you don't already know about Screensteps and you ever create
> documentation or need to show someone how to do something occasionally -
> you owe it to yourself to learn about it.  It even makes creating
> screenshot-based documentation fun.  (Alas, I have no investment or
> business affiliation with Blue Mango the company that produces it).
>
>
>
> On 1/16/12 10:56 AM, "Ross Gardler"<rg...@opendirective.com>  wrote:
>
>> On 16 January 2012 15:52, Franklin, Matthew B.<mf...@mitre.org>
>> wrote:
>>
>> ...
>>
>>> As a first step, I took a look at the remaining work items on our status
>>> page that need to be completed and updated the dates for the ones we
>>> have
>>> finished, but had not recorded.  That leaves us with the following list
>>> of
>>> items:
>>>
>>> * Make sure that the requested project name does not already exist and
>>> check www.nameprotect.com to be sure that the name is not already
>>> trademarked for an existing software product.
>>
>> Important
>>
>>> * If request from anywhere to become a stand-alone PMC, then assess the
>>> fit with the ASF, and create the lists and modules under the incubator
>>> address/module names if accepted.
>>
>> Important
>>
>>> * Ask infrastructure to set up wiki (Confluence, Moin).
>>
>> Does the project want one? Not needed so far and not needed for
>> graduation. You can always ask for one as a TLP if you change your
>> minds.
>>
>>> * Check and make sure that the files that have been donated have been
>>> updated to reflect the new ASF copyright.
>>
>> Already done, surely?
>>
>> Ross
>>
>
>

Re: Graduation? - Confluence Wiki option

[Ross Gardler <rg...@opendirective.com>]

Sent from my mobile device, please forgive errors and brevity.
On Jan 16, 2012 5:42 PM, "William Hayes" <Wi...@biogenidec.com>
wrote:
>
> Can the iCLA be signed as a clickthrough form in setting up an account on
> the wiki?  Or does it need to be manually signed?

Click throughs are, AIUI, legally meaningless. They are a mechanism to
ensure the user has thought about it.

The rules are the same as for choose, minor contributions don't need an
ICLA significant ones do. The problem with wiki's is that there is no
equivalent to a patch. It's all or nothing.

Note the CMS does have anonymous contributions by patch, both via the UI
and via SVN.

Ross

>
> On 1/16/12 12:30 PM, "Ross Gardler" <rg...@opendirective.com> wrote:
>
> >On 16 January 2012 16:31, William Hayes <Wi...@biogenidec.com>
> >wrote:
> >> +1 Regarding using Confluence Wiki for support documentation, knowledge
> >> sharing.
> >>
> >> Setting up a wiki for documentation would help a lot
> >
> >Note that if you intend to open up the site for people who have not
> >signed an iCLA then this is unnofficial documentation. It cannot be
> >packaged as official documentation under the Apache licence in these
> >circumstances.
> >
> >This may or may not be a problem for the project, just thought I'd
> >make you aware.
> >
> >Ross
> >
>
>

Re: Graduation? - Confluence Wiki option

["Franklin, Matthew B." <mf...@mitre.org>]

On 1/16/12 12:42 PM, "William Hayes" <Wi...@biogenidec.com> wrote:

>Can the iCLA be signed as a clickthrough form in setting up an account on
>the wiki?  Or does it need to be manually signed?

They must be recorded with the secretary and can be submitted only via
e-mail, fax, post [1].

That being said, I think that having both official & "unofficial"
(community) documentation might be OK.  It gives the community a low
barrier of entry whilst preserving the integrity of project documentation.
Thoughts?

[1] http://www.apache.org/licenses/


>
>On 1/16/12 12:30 PM, "Ross Gardler" <rg...@opendirective.com> wrote:
>
>>On 16 January 2012 16:31, William Hayes <Wi...@biogenidec.com>
>>wrote:
>>> +1 Regarding using Confluence Wiki for support documentation, knowledge
>>> sharing.
>>>
>>> Setting up a wiki for documentation would help a lot
>>
>>Note that if you intend to open up the site for people who have not
>>signed an iCLA then this is unnofficial documentation. It cannot be
>>packaged as official documentation under the Apache licence in these
>>circumstances.
>>
>>This may or may not be a problem for the project, just thought I'd
>>make you aware.
>>
>>Ross
>>
>
>

Re: Graduation? - Confluence Wiki option

[William Hayes <Wi...@biogenidec.com>]

Can the iCLA be signed as a clickthrough form in setting up an account on
the wiki?  Or does it need to be manually signed?

On 1/16/12 12:30 PM, "Ross Gardler" <rg...@opendirective.com> wrote:

>On 16 January 2012 16:31, William Hayes <Wi...@biogenidec.com>
>wrote:
>> +1 Regarding using Confluence Wiki for support documentation, knowledge
>> sharing.
>>
>> Setting up a wiki for documentation would help a lot
>
>Note that if you intend to open up the site for people who have not
>signed an iCLA then this is unnofficial documentation. It cannot be
>packaged as official documentation under the Apache licence in these
>circumstances.
>
>This may or may not be a problem for the project, just thought I'd
>make you aware.
>
>Ross
>

Re: Graduation? - Confluence Wiki option

[Ross Gardler <rg...@opendirective.com>]

On 16 January 2012 16:31, William Hayes <Wi...@biogenidec.com> wrote:
> +1 Regarding using Confluence Wiki for support documentation, knowledge
> sharing.
>
> Setting up a wiki for documentation would help a lot

Note that if you intend to open up the site for people who have not
signed an iCLA then this is unnofficial documentation. It cannot be
packaged as official documentation under the Apache licence in these
circumstances.

This may or may not be a problem for the project, just thought I'd
make you aware.

Ross