Just an idea of how we could eventually make writing the documentation a little easier and keep flexible regarding the used CMS.
I use Asciidoctor for writing documentation. It's the same markup you use on Github to auto-render these nice looking sites. The good thing would be that we can continue to use the infra that we have. I already added support for this in falcon also some example files in "src/site/asciidoc". The cool thing with this option is that maven supports auto-updating the project site with the latest content AND you have the documentation in the same place as you have the code. It automatically produces a project website together with the JavaDoc and all the other project reports. To try it out, just go to the falcon repo and run "mvn site:site" (Alternatively "mvn site"). This will produce a directory "target/site" You can also have a look at the output it creates at [1]. In order to access that url you have to login to jenkins using your normal apache credentials. The pages "Building from source" and "Build structure" are generated from the two asciidoctor files. Please give it a try. I think we should start going down that path for documentation, but that's just my opinion. Chris [1]: https://builds.apache.org/view/E-G/view/Flex/job/FlexJS%20Compiler%20(maven)/ws/target/site/index.html ________________________________ Von: OK <p...@olafkrueger.net> Gesendet: Freitag, 9. September 2016 08:59:05 An: dev@flex.apache.org Betreff: Re: [FlexJS] Starting with the Docs Alex Harui wrote > Depending on how you look at it, each class is a component, or maybe only > classes listed in manifest.xml files are components. > You might get a directory listing or parse the manifest files. > I've been tempted to find a way to mark or annotate classes as being > intended for application developers as opposed to framework developers. I've just browsed through the asjs repo and it seems to me that it is already a challenge to get list of the relevant classes/components. I've found e.g. [1] wich is probably a summary of the core components. Would that be the way to search for this file inside each "component set" to get an overview of all components? Alex Harui wrote > I'm still hoping we can be more efficient about the doc. If we know there > is going to be a Tour de FlexJS, we should put the examples in there as > opposed to having examples in both places, and link back and forth between > the doc and Tour de FlexJS, and probably the ASDoc as well. Maybe the wiki is not the best place to start with the docs... What do you think of using github? We could start with a repo that contains examples for the particular components and maybe this could be consumend by an "Tour de FlexJS" app using the github API? Thanks, Olaf [1] https://github.com/apache/flex-asjs/blob/develop/frameworks/projects/Core/src/main/resources/basic-manifest.xml -- View this message in context: http://apache-flex-development.2333347.n4.nabble.com/FlexJS-Starting-with-the-Docs-tp55005p55012.html Sent from the Apache Flex Development mailing list archive at Nabble.com.
