Two problems: 1. Making edits requires logging into the wiki and making the edits online in the editor. It’s much more user friendly to be able to write docs in a text editor on your local machine. 2. It’s not horribly ugly, but it’s not what I’d call attractive.
On May 2, 2016, at 7:04 AM, Alex Harui <aha...@adobe.com> wrote: > > > On 5/1/16, 10:38 AM, "Harbs" <harbs.li...@gmail.com> wrote: > >> I created a repo on Github to play with Github Pages. I copied the >> landing page for the wiki[1], and the results are definitely improved.[2] >> >> Making the page more useful seems to require learning Jekyll or >> something. That’s more time than I have right now. If someone who knows >> this stuff better than I do want’s to take a stab at this, please let me >> know… >> >> [1]https://cwiki.apache.org/confluence/display/FLEX/FlexJS >> [2]http://flex-extras.github.io/flexjs-docs/ > > > FWIW, what is it that you don't like about the Wiki? I used to really > hate them, but whatever we are using right now isn't a problem for me. > > -Alex > >> >> On Apr 18, 2016, at 12:21 AM, Harbs <harbs.li...@gmail.com> wrote: >> >>> Hi Andrew, >>> >>> Thanks so much for offering to help!!! >>> >>> We got a bit sidetracked talking about publishing technologies… ;-) >>> >>> The wiki is a pretty good starting point. >>> https://cwiki.apache.org/confluence/display/FLEX/Apache+Flex+Wiki >>> >>> It’s not as well organized as it could be, and there’s huge gaps in the >>> info you can find there, but it has somewhat of an outline and there’s a >>> lot of info there (at least to get started). >>> >>> On Apr 14, 2016, at 12:38 AM, Andrew Wetmore <cottag...@gmail.com> >>> wrote: >>> >>>> I have good writing skills and have headed doc teams for software >>>> companies >>>> large and small. I have built doc platforms with Madcap Flare and other >>>> tools, but when I am working on a shoestring I prefer HelpScribble ( >>>> https://www.helpscribble.com/). I would be glad to help with this, >>>> especially if someone could point me to the existing documentation and >>>> help >>>> me develop a table of contents to populate. >>>> >>>> a >>>> >>>> On Wed, Apr 13, 2016 at 5:09 PM, Harbs <harbs.li...@gmail.com> wrote: >>>> >>>>> Documentation on the Flex SDK is pretty mature. You can find just >>>>> about >>>>> anything you want on the web. >>>>> >>>>> FlexJS has next to nothing. As things are ramping up with FlexJS, >>>>> there is >>>>> more an more functionality buried here in the dev list. I know I tend >>>>> to be >>>>> really bad at documentation. Even if we were perfect about ASDoc >>>>> comments >>>>> in the source code, that only helps for API documentation. Beyond >>>>> that we >>>>> have a strong need for general usage documentation. This includes >>>>> general >>>>> background, workflow, component usage, compiler arguments, IDEs, >>>>> contribution, integrating third party libraries, etc. Do we have >>>>> anyone >>>>> subscribing to the list who has good writing skills who might want to >>>>> take >>>>> on some of this? Does anyone have a good documentation platform to >>>>> display >>>>> and help people find the info easily. (No. I don’t think the wiki is >>>>> a good >>>>> platform for that.) I think Angular has a good documentation site[1]. >>>>> (Of >>>>> course they probably had a team dedicated to writing it.) >>>>> >>>>> Thoughts? >>>>> >>>>> Harbs >>>>> >>>>> [1]https://docs.angularjs.org/guide >>>> >>>> >>>> >>>> >>>> -- >>>> Andrew Wetmore >>>> >>>> http://cottage14.blogspot.com/ >>> >> >
