royale-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alex Harui <aha...@adobe.com.INVALID>
Subject Re: Migrating existing FlexJS documentation to Royale
Date Thu, 18 Jan 2018 23:23:41 GMT
Hi Andrew,

I've been thinking that we don't want to directly copy the FlexJS pages to
GH Pages.  I think it needs better organization.  I think the question for
you is how much time you have and what you would like to do with your
time.  I'm hoping to spend some time on doc once RC2 is posted.  I can
certainly type in a lot of words.  If your strong suit and time is better
aimed at editing and organization, then we should find a way to make that
work.  If you have a vision of the organization of the doc and want to put
together the skeleton of the doc set and leave lots of placeholders, I can
try to fill in those placeholders and you can edit it after.

I've looked at the Adobe doc a bit.  I'm not sure that's what I want
either, but it made me realize that we don't have pages like "What is
MXML" and how to use it.  We are for now assuming folks are
Flex-knowledgeable, which I think is ok.

I think we do need to use MarkDown and Jekyll (or maybe Royale).  I was
trying to think through how to get the branding around a pile of HTML
pages.  Doesn't sound easy.

Thoughts?
-Alex

On 1/18/18, 3:15 AM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
<carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> wrote:

>Hi Andrew,
>
>I think the initial approach is ok. We need to work all together since we
>need:
>
>* Technical info that is accurate to help people get started or solve a
>problem with some part of Royale
>* Be as clear as possible in terms of organization (how to organize the
>content), grammatical constructs, and more.
>
>So this task needs some kind of retro feedback between people working in
>docs and people working on code.
>
>I'm working in parallel in a theme for the docs, still looking how it's
>done, but hope to let you know something as I have things more clear.
>
>thanks
>
>Carlos
>
>
>
>2018-01-18 1:04 GMT+01:00 Andrew Wetmore <cottage14@gmail.com>:
>
>> Hi, all:
>>
>> I want to start upgrading the very useful documentation we have that
>> currently refers to FlexJS [1]. At the very least every document needs
>> edits to make sure it refers to Royale.
>>
>> However, there are some other considerations:
>>
>>    - Is there material that needs to be rewritten because Royale has
>>    evolved away from FlexJS? I will need help identifying stuff that is
>> out of
>>    phase with the current project.
>>    - The existing material is good, but not comprehensive. I'll be
>>happy to
>>    help extend the documentation, building out along the lines
>>indicated by
>>    the stub table of contents here: [2]. However, I am primarily a
>>writer
>> who
>>    dabbles in code, rather than a coder who writes. I see two ways
>>forward:
>>       - I write material using my naive best-guess approach and my
>>library
>>       of Flex resources, and then people who are actually, you know,
>> smart about
>>       this stuff help me correct all my gaffes and oversights.
>>       - People who know the code blurt out their information on a
>>       particular topic without worrying too much about polishing it, and
>> then I
>>       help rework it until it is attractive and informative to the
>>intended
>>       audience.
>>    - There should be a new blog entry every week at least so there is
>>    almost always something fresh for a site visitor to enjoy. I can
>>think
>> of
>>    lots of titles, but probably do not have the technical smarts to get
>>all
>>    the details right.
>>
>> This leaves to one side for the moment the question of whether we are
>>using
>> MarkDown or HTML for the documentation pages, although I think it is
>>clear
>> we are not using a wiki.
>>
>> 1. 
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcwiki.ap
>>ache.org%2Fconfluence%2Fdisplay%2FFLEX%2FFlex%2BJS&data=02%7C01%7Caharui%
>>40adobe.com%7C80debf76730a430634a708d55e64cddb%7Cfa7b1b5a7b34438794aed2c1
>>78decee1%7C0%7C0%7C636518709399733882&sdata=F4338HNri%2F6TU%2B%2BkcLVcNS%
>>2FeCpiMC%2Bo7NMVidsK5d7Y%3D&reserved=0
>>
>> 2. 
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.c
>>om%2Folafkrueger%2Fflexjs-docs%2Fwiki&data=02%7C01%7Caharui%40adobe.com%7
>>C80debf76730a430634a708d55e64cddb%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%
>>7C0%7C636518709399733882&sdata=S5XQQo5X1LPq5wpK6pxeSa4eNzcjj84epnrNZnQLsw
>>o%3D&reserved=0
>>
>> --
>> Andrew Wetmore
>>
>> 
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14
>>.blogspot.com%2F&data=02%7C01%7Caharui%40adobe.com%7C80debf76730a430634a7
>>08d55e64cddb%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636518709399733
>>882&sdata=qMP8jV2U9SnOXiEKOiZodsYZLZfQUz3FsBYE0xN4Wjw%3D&reserved=0
>>
>
>
>
>-- 
>Carlos Rovira
>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fabout.me%2
>Fcarlosrovira&data=02%7C01%7Caharui%40adobe.com%7C80debf76730a430634a708d5
>5e64cddb%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636518709399733882&s
>data=JZEmwtXJfb7QH71Cnt6yCprASeLEDlzmGbIc%2BkBVM2M%3D&reserved=0

Mime
View raw message