Fortress documentation migration

[Emmanuel Lécharny <el...@gmail.com>]

Hi Shawn,

I have started the Fortress documentation migration. There are many
aspects that need to be adressed, like :
- documentation organization
- Javadoc
- per product documentation
- user guide/quick start guide/implementation guide
 and maybe some more.

I have already migrated teh quick start guides, which need a review (at
some point, having 3 different guide with a lot of redondancies can
probably be simplified).

Can we discuss the best way to expose teh 4 different products
documentation ?

Thanks !

Re: Fortress documentation migration

[Emmanuel Lécharny <el...@gmail.com>]

Le 12/10/14 12:40, Pierre Smits a écrit :
> Hi Emannuel, Shawn,
>
> Can I have a pointer to where I can see the documentation migrated to. I
> will then have a look and try to help out.

All the documentation is under
https://svn.apache.org/repos/asf/directory/site/trunk.

The Fortress specific part is under content/fortress.

We are using the Apache CMS for anything related to the site (see
http://www.apache.org/dev/cms.html)

The existing Fortress documentation is under
http://iamfortress.org/documentation

Re: Fortress documentation migration

[Pierre Smits <pi...@gmail.com>]

Hi Emannuel, Shawn,

Can I have a pointer to where I can see the documentation migrated to. I
will then have a look and try to help out.

Regards,

Pierre Smits

*ORRTIZ.COM <http://www.orrtiz.com>*
Services & Solutions for Cloud-
Based Manufacturing, Professional
Services and Retail & Trade
http://www.orrtiz.com

On Sat, Oct 11, 2014 at 7:52 PM, Emmanuel Lécharny <el...@gmail.com>
wrote:

> Hi Shawn,
>
> I have started the Fortress documentation migration. There are many
> aspects that need to be adressed, like :
> - documentation organization
> - Javadoc
> - per product documentation
> - user guide/quick start guide/implementation guide
>  and maybe some more.
>
> I have already migrated teh quick start guides, which need a review (at
> some point, having 3 different guide with a lot of redondancies can
> probably be simplified).
>
> Can we discuss the best way to expose teh 4 different products
> documentation ?
>
> Thanks !
>
>

Re: Fortress documentation migration

[Stephan Fabel <sf...@hawaii.edu>]

If you need help with this, let me know.

Thanks,
Stephan

On Sun, Oct 12, 2014 at 5:56 AM, Shawn McKinney <mc...@att.net>
wrote:

> On 10/11/2014 12:52 PM, Emmanuel Lécharny wrote:
>
>> I have already migrated teh quick start guides, which need a review (at
>> some point, having 3 different guide with a lot of redondancies can
>> probably be simplified).
>>
>
> My concern is redundancy and keeping everything in synch as the product
> matures, which is why I like javadoc, because it naturally stays in synch
> across versions.
>
> (who remembers to update the website's doc with each release of source?)
>
> On 10/11/2014 12:52 PM, Emmanuel Lécharny wrote:> Can we discuss the best
> way to expose teh 4 different products
> > documentation ?
>
> Missing from here:
>
> http://directory.staging.apache.org/fortress/
>
> is the (1) developers guide and (2) five minute tutorial.  Also needed is
> (3) fortress architectural document that describes how the system was built
> / operates.
>
> What else do we need in order to have a 'complete' set of documentation?
>
> Once we have this list, we can prioritize and tackle in order.
>



-- 
Stephan Fabel
College of Education, University of Hawaii at Manoa
Cell (260) 232-2357

Re: Fortress documentation migration

[Shawn McKinney <mc...@att.net>]

On 10/11/2014 12:52 PM, Emmanuel Lécharny wrote:
> I have already migrated teh quick start guides, which need a review (at
> some point, having 3 different guide with a lot of redondancies can
> probably be simplified).

My concern is redundancy and keeping everything in synch as the product 
matures, which is why I like javadoc, because it naturally stays in 
synch across versions.

(who remembers to update the website's doc with each release of source?)

On 10/11/2014 12:52 PM, Emmanuel Lécharny wrote:> Can we discuss the 
best way to expose teh 4 different products
 > documentation ?

Missing from here:

http://directory.staging.apache.org/fortress/

is the (1) developers guide and (2) five minute tutorial.  Also needed 
is (3) fortress architectural document that describes how the system was 
built / operates.

What else do we need in order to have a 'complete' set of documentation?

Once we have this list, we can prioritize and tackle in order.