Hi Alex,

actually that's not quite true. We have the Wiki and the Website. The problem 
is that usually changing the website is far more work than to edit the wiki. 
The thing with the Maven Site generation however is that it automatically 
generates the entire Project documentation AND automatically updates the 
content in Subversion. All is prepared to start doing this, but I disabled the 
final upload of the generated site as we haven't discussed that yet and I 
didn't want to do it without. Even if linking to ASDoc on the Flex Buildserver 
works, the server isn't really great from a performance point of view. Having 
the documentation on the main Apache Webservers would definitely be nicer.


Have you guys had a look at the links I provided? The cool thing with them is 
that they are absolutely standard and anyone will know where to look for what 
information. Every maven-based projects has the same.


Chris

________________________________
Von: Alex Harui <aha...@adobe.com>
Gesendet: Samstag, 10. September 2016 07:12:31
An: dev@flex.apache.org
Betreff: Re: [FlexJS] Starting with the Docs



On 9/9/16, 12:19 PM, "Nemi" <nemino...@gmail.com> wrote:

>As from my perspective as Flex SDK user, current wiki is like unorganized
>book. And it has info for sdk-developers and for sdk-users, which IMHO,
>must
>be always separated.
>
>For a start, I think docs should be on some nice named location like:
>http://flex.apache.org/flexjs/docs

Eventually we will get away from the wiki, but it is all we have for now
until we decide how to do the future doc.  Wiki does allow comments.  I
added an HTTP redirect so your url ends up at the FlexJS section of the
wiki (for now).

I also added the FlexJS ASDoc to the Documentation menu.  It goes to the
CI server (apacheflexbuild) because copying ASDoc in the current CMS is
painful, and I'd rather show a live version for now in hopes that new
contributors will help improve the doc and will be able to see their
improvements in the nightly build without requiring someone to use the
CMS.  For some reason the FlexJS ASDoc has two title-bars.  Volunteers are
welcome to help debug that.

Thanks,
-Alex

Reply via email to