@Alex, please check this link for licenses [1] and let me know if is ok for us to use this theme as base
The results can be seen in [2] I see others as well that are MIT only and very few that are ALv2. I assume that both are ok for us. My intention is configure royale-docs to use that theme (or other similar under MIT or ALv2) and config fonts, colors and sizes a bit to match our branding. In the case of [1] there's another license involved (jquery) Thanks [1] https://github.com/tomjoht/documentation-theme-jekyll/tree/gh-pages/licenses [2] http://idratherbewriting.com/documentation-theme-jekyll/ 2018-01-19 0:46 GMT+01:00 Andrew Wetmore <[email protected]>: > I am fine with using MarkDown if someone can assure me that there will, > eventually, be a way to display a navigable index that will help the reader > jump around through the pages. > > On Thu, Jan 18, 2018 at 7:44 PM, Alex Harui <[email protected]> > wrote: > > > OK, I'm sure you will figure it out. But if we all agree on MarkDown, I > > think we can start writing content in MarkDown and committing it? Then > > later, the theme will just magically appear or maybe we have to add a tag > > or two to each page? > > > > -Alex > > > > On 1/18/18, 3:36 PM, "[email protected] on behalf of Carlos > Rovira" > > <[email protected] on behalf of [email protected]> wrote: > > > > >Hi Alex, > > > > > >I'm right now fighting with Jekyll and themes. I have working a minimal > > >example localy and trying to see how to: > > > > > >* Jekyll themes work in order to configure a basic one with basic > website > > >royale branding (fonts, colors and sizes) > > >* How this means for ease of development, I'm still trying to see the > > >whole > > >picture > > > > > >I'll come back with my research > > > > > >Carlos > > > > > > > > >2018-01-19 0:23 GMT+01:00 Alex Harui <[email protected]>: > > > > > >> 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, "[email protected] on behalf of Carlos > > >>Rovira" > > >> <[email protected] on behalf of [email protected]> 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 <[email protected]>: > > >> > > > >> >> 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%7Cfa7b1b5a7b34438794aed2c178de > > >> cee1%7C0% > > >> >>7C0%7C636518709399733882&sdata=S5XQQo5X1LPq5wpK6pxeSa4eNzcjj8 > > >> 4epnrNZnQLsw > > >> >>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%7Cfa7b1b5a7b34438794aed2c178de > > >> cee1%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 > > >> > > >> > > > > > > > > >-- > > >Carlos Rovira > > >https://na01.safelinks.protection.outlook.com/?url= > > http%3A%2F%2Fabout.me%2 > > >Fcarlosrovira&data=02%7C01%7Caharui%40adobe.com% > > 7Cc10f3bcdb7c845ab3c6508d5 > > >5ecc66a2%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0% > > 7C636519154348905597&s > > >data=LddHhy3VBm431%2BCCTdVlIfQaLJ3wg4AiHuVkH%2FDeyeo%3D&reserved=0 > > > > > > > -- > Andrew Wetmore > > http://cottage14.blogspot.com/ > -- Carlos Rovira http://about.me/carlosrovira
