You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@royale.apache.org by Andrew Wetmore <co...@gmail.com> on 2018/01/18 00:04:16 UTC
Migrating existing FlexJS documentation to Royale
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://cwiki.apache.org/confluence/display/FLEX/Flex+JS
2. https://github.com/olafkrueger/flexjs-docs/wiki
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Migrating existing FlexJS documentation to Royale
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
Or possibly you could just link the markdown content to "src/site/markdown” (ln -s ../../../royale-docs markdown from /src/site is royale-asjs) [1] and do a “mvn site site:stage” to test locally and a "mvn site-deploy” to deploy if you have permission. I believe Chris set this all of this up a while back. I think you need to add and set absoluteResourceURL to site.xml.
Might be worth a try anyway if you want a quick and easy way to do this.
Thanks,
Justin
[1] https://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
OK, got jekyll working locally. I followed these instructions:
https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver
/standalone/oss/install_language_runtime.html
One of the steps was to install bundler. That might be why you got the
.bundle error.
You will also need to copy _config.yml to local_config.yml and edit the
baseurl to the path to your repo. You will get errors in the console that
it can't load the CSS until you get that right.
Then I set the current directory to the royale-docs repo and run:
jekyll build --config local_config.yml
I did this on my Mac. The CI server is running Jekyll on Windows. I
followed the steps for installing Jekyll on Cygwin because the CI server
is running a version of Windows that may not be supported by Ubuntu on
Windows. I followed this post:
https://matt.scharley.me/2012/03/windows-cygwin-and-jekyll.html
HTH,
-Alex
On 1/24/18, 3:36 PM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>I haven't been testing locally. I just push it and build it on the CI
>server.
>
>I will look into building it locally. On the CI server, we are only using
>"Jekyll build" and not "Jekyll serve". And you will probably have to use
>a custom config file to override the default baseurl.
>
>Right now, the site is so small that it builds really quickly, so I don't
>think I care if you also just push/build/test. Just let us know when you
>are in there so we don't make other changes to the files.
>
>I'll post instructions for local builds once I figure it out.
>
>-Alex
>
>On 1/24/18, 2:51 PM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
><carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> wrote:
>
>>Thanks Alex,
>>I can see it working online :)
>>I'm trying to test it localy but don't know how to do it.
>>In order to make the html/css looks good, I need to work localy, please
>>let
>>me know how yo do it
>>I installed already ruby, jekyll, etc... and tried to run "bundle exec
>>jekyll serve" but we don't have Gem file result is:
>>
>>Could not locate Gemfile or .bundle/ directory
>>
>>Maybe there's a more easy way to test this.
>>
>>Carlos
>>
>>
>>2018-01-19 21:59 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
>>
>>> OK, I got the CSS to load. You can hit this link:
>>>
>>>
>>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapache.
>>>g
>>>ithub.io%2Froyale-docs%2Ftest%2Ftest.html&data=02%7C01%7Caharui%40adobe.
>>>c
>>>om%7Cef158780d4714a61dfb908d5637d039e%7Cfa7b1b5a7b34438794aed2c178decee1
>>>%
>>>7C0%7C0%7C636524310941764543&sdata=mD2KTprJ9GvEsEjVw1k256pI8yq0BbP%2F%2B
>>>o
>>>DkQhpAckI%3D&reserved=0
>>>
>>> I'm going to look into automatic TOC generation next. IMO, we should
>>> decide what kind of header/footer we want not only for the docs on this
>>> site, but for ASDoc and Olaf's TryItNow as well and start implementing
>>>it.
>>> Like this page, it may not look great right away, but we can iterate
>>> towards making it look good.
>>>
>>> My 2 cents,
>>> -Alex
>>>
>>> On 1/19/18, 1:10 AM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>>>
>>> >I'm out of time for today, but I tested templates and jekyll and
>>>started
>>> >to get something to work.
>>> >
>>> >https://na01.safelinks.protection.outlook.com/?url=
>>> https%3A%2F%2Fapache.gi
>>> >thub.io%2Froyale-docs%2Ftest%2Ftest.html&data=02%7C01%7Caharui%
>>> 40adobe.com
>>> >%7C8d9c2ab112564497fb2608d55f1c7c23%7Cfa7b1b5a7b34438794aed2c178de
>>> cee1%7C0
>>> >%7C0%7C636519498299260185&sdata=2egj2BghYos4ur%
>>> 2FUSpvN4Vrzh8IOj6rPngvyAJe8
>>> >ZqM%3D&reserved=0
>>> >
>>> >You can see the test/test.md and _layouts/docpage.html in the
>>>royals-docs
>>> >repo. The CSS file didn't load for some reason. Feel free to figure
>>>it
>>> >out or I will look into it tomorrow.
>>> >
>>> >HTH,
>>> >-Alex
>>> >
>>> >On 1/18/18, 6:08 PM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>>> >
>>> >>This is for doc, not code so I'm not sure the issue I raised matters.
>>> >>
>>> >>That said, I've been reading this [1] and it seems like we should be
>>>able
>>> >>to set up a few templates sort of like we did flex.a.o and not worry
>>>so
>>> >>much about customizing a third-party theme.
>>> >>
>>> >>[1]
>>> >>https://na01.safelinks.protection.outlook.com/?url=
>>> https%3A%2F%2Fjekyllrb
>>> >>.
>>> >>com%2Fdocs&data=02%7C01%7Caharui%40adobe.com%
>>> 7C6fca45a581614f01bbd008d55e
>>> >>e
>>> >>190da%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>>> 7C636519245260410634&sda
>>> >>t
>>> >>a=SnZeokcfQXRyaHs338A04ENYTLx%2FWSwo42KPSsA3S9k%3D&reserved=0
>>> >>
>>> >>On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com>
>>>wrote:
>>> >>
>>> >>>Carlos,
>>> >>>
>>> >>>I like your findings jeckyll theme doc.
>>> >>>
>>> >>>It looks like we may have again similar issue with license as we
>>>have in
>>> >>>MDLExample.
>>> >>>
>>> >>>Can someone raise jira for both cases? Alex raises question on legal
>>> >>>couple
>>> >>>of days ago. No responses. Let's not wait block us with it - push
>>>things
>>> >>>forward. Jira could be better to do this.
>>> >>>
>>> >>>Thanks,
>>> >>>Piotr
>>> >>>
>>> >>>On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
>>> >>>wrote:
>>> >>>
>>> >>>> Hi,
>>> >>>>
>>> >>>> > I think this looks very good and seems to be responsive
>>> >>>> >
>>> >>>> >
>>> >>>>[1]https://na01.safelinks.protection.outlook.com/?url=
>>> http%3A%2F%2Fmist
>>> >>>>i
>>> >>>>c
>>>
>>>>>>>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.c
>>>>>>>o
>>>>>>>m
>>> %
>>> >>>>7
>>> >>>>C
>>> >>>>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
>>> cee1%7C0
>>> >>>>%
>>> >>>>7
>>> >>>>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%
>>> 2FpwSfe9bxwJd6N%2BmnyMC0pK%
>>> >>>>2
>>> >>>>F
>>> >>>>EepY8o%3D&reserved=0
>>> >>>> > [2]
>>> >>>>https://na01.safelinks.protection.outlook.com/?url=
>>> https%3A%2F%2Fgithub
>>> >>>>.
>>> >>>>c
>>> >>>>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com
>>> %7C9c1
>>> >>>>6
>>> >>>>8
>>> >>>>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
>>> cee1%7C0%7C0%
>>> >>>>7
>>> >>>>C
>>> >>>>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%
>>> 2BzoXqck04VV68TxcIKFs%
>>> >>>>3
>>> >>>>D
>>> >>>>&reserved=0
>>> >>>>
>>> >>>> From a quick look this contains CSS code licensed under CC-BY-3.0
>>> >>>>(looks
>>> >>>> like it comes from bootstrap docs). That may or may not be an
>>>issue,
>>> >>>> depending on the current conversation around this on legal
>>>discuss,
>>> >>>>and
>>> >>>> what you want to do with it.
>>> >>>>
>>> >>>> Thanks,
>>> >>>> Justin
>>> >>
>>> >
>>>
>>>
>>
>>
>>--
>>Carlos Rovira
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fabout.me%
>>2
>>Fcarlosrovira&data=02%7C01%7Caharui%40adobe.com%7Cef158780d4714a61dfb908d
>>5
>>637d039e%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636524310941764543&
>>s
>>data=J7QoUjj3VjvkcYhHaGAdqW3%2B8XU0a2ctG04LorBuYWI%3D&reserved=0
>
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
I haven't been testing locally. I just push it and build it on the CI
server.
I will look into building it locally. On the CI server, we are only using
"Jekyll build" and not "Jekyll serve". And you will probably have to use
a custom config file to override the default baseurl.
Right now, the site is so small that it builds really quickly, so I don't
think I care if you also just push/build/test. Just let us know when you
are in there so we don't make other changes to the files.
I'll post instructions for local builds once I figure it out.
-Alex
On 1/24/18, 2:51 PM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
<carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> wrote:
>Thanks Alex,
>I can see it working online :)
>I'm trying to test it localy but don't know how to do it.
>In order to make the html/css looks good, I need to work localy, please
>let
>me know how yo do it
>I installed already ruby, jekyll, etc... and tried to run "bundle exec
>jekyll serve" but we don't have Gem file result is:
>
>Could not locate Gemfile or .bundle/ directory
>
>Maybe there's a more easy way to test this.
>
>Carlos
>
>
>2018-01-19 21:59 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
>
>> OK, I got the CSS to load. You can hit this link:
>>
>>
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapache.g
>>ithub.io%2Froyale-docs%2Ftest%2Ftest.html&data=02%7C01%7Caharui%40adobe.c
>>om%7Cef158780d4714a61dfb908d5637d039e%7Cfa7b1b5a7b34438794aed2c178decee1%
>>7C0%7C0%7C636524310941764543&sdata=mD2KTprJ9GvEsEjVw1k256pI8yq0BbP%2F%2Bo
>>DkQhpAckI%3D&reserved=0
>>
>> I'm going to look into automatic TOC generation next. IMO, we should
>> decide what kind of header/footer we want not only for the docs on this
>> site, but for ASDoc and Olaf's TryItNow as well and start implementing
>>it.
>> Like this page, it may not look great right away, but we can iterate
>> towards making it look good.
>>
>> My 2 cents,
>> -Alex
>>
>> On 1/19/18, 1:10 AM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>>
>> >I'm out of time for today, but I tested templates and jekyll and
>>started
>> >to get something to work.
>> >
>> >https://na01.safelinks.protection.outlook.com/?url=
>> https%3A%2F%2Fapache.gi
>> >thub.io%2Froyale-docs%2Ftest%2Ftest.html&data=02%7C01%7Caharui%
>> 40adobe.com
>> >%7C8d9c2ab112564497fb2608d55f1c7c23%7Cfa7b1b5a7b34438794aed2c178de
>> cee1%7C0
>> >%7C0%7C636519498299260185&sdata=2egj2BghYos4ur%
>> 2FUSpvN4Vrzh8IOj6rPngvyAJe8
>> >ZqM%3D&reserved=0
>> >
>> >You can see the test/test.md and _layouts/docpage.html in the
>>royals-docs
>> >repo. The CSS file didn't load for some reason. Feel free to figure
>>it
>> >out or I will look into it tomorrow.
>> >
>> >HTH,
>> >-Alex
>> >
>> >On 1/18/18, 6:08 PM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>> >
>> >>This is for doc, not code so I'm not sure the issue I raised matters.
>> >>
>> >>That said, I've been reading this [1] and it seems like we should be
>>able
>> >>to set up a few templates sort of like we did flex.a.o and not worry
>>so
>> >>much about customizing a third-party theme.
>> >>
>> >>[1]
>> >>https://na01.safelinks.protection.outlook.com/?url=
>> https%3A%2F%2Fjekyllrb
>> >>.
>> >>com%2Fdocs&data=02%7C01%7Caharui%40adobe.com%
>> 7C6fca45a581614f01bbd008d55e
>> >>e
>> >>190da%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>> 7C636519245260410634&sda
>> >>t
>> >>a=SnZeokcfQXRyaHs338A04ENYTLx%2FWSwo42KPSsA3S9k%3D&reserved=0
>> >>
>> >>On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com>
>>wrote:
>> >>
>> >>>Carlos,
>> >>>
>> >>>I like your findings jeckyll theme doc.
>> >>>
>> >>>It looks like we may have again similar issue with license as we
>>have in
>> >>>MDLExample.
>> >>>
>> >>>Can someone raise jira for both cases? Alex raises question on legal
>> >>>couple
>> >>>of days ago. No responses. Let's not wait block us with it - push
>>things
>> >>>forward. Jira could be better to do this.
>> >>>
>> >>>Thanks,
>> >>>Piotr
>> >>>
>> >>>On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
>> >>>wrote:
>> >>>
>> >>>> Hi,
>> >>>>
>> >>>> > I think this looks very good and seems to be responsive
>> >>>> >
>> >>>> >
>> >>>>[1]https://na01.safelinks.protection.outlook.com/?url=
>> http%3A%2F%2Fmist
>> >>>>i
>> >>>>c
>>
>>>>>>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.co
>>>>>>m
>> %
>> >>>>7
>> >>>>C
>> >>>>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
>> cee1%7C0
>> >>>>%
>> >>>>7
>> >>>>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%
>> 2FpwSfe9bxwJd6N%2BmnyMC0pK%
>> >>>>2
>> >>>>F
>> >>>>EepY8o%3D&reserved=0
>> >>>> > [2]
>> >>>>https://na01.safelinks.protection.outlook.com/?url=
>> https%3A%2F%2Fgithub
>> >>>>.
>> >>>>c
>> >>>>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com
>> %7C9c1
>> >>>>6
>> >>>>8
>> >>>>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
>> cee1%7C0%7C0%
>> >>>>7
>> >>>>C
>> >>>>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%
>> 2BzoXqck04VV68TxcIKFs%
>> >>>>3
>> >>>>D
>> >>>>&reserved=0
>> >>>>
>> >>>> From a quick look this contains CSS code licensed under CC-BY-3.0
>> >>>>(looks
>> >>>> like it comes from bootstrap docs). That may or may not be an
>>issue,
>> >>>> depending on the current conversation around this on legal discuss,
>> >>>>and
>> >>>> what you want to do with it.
>> >>>>
>> >>>> Thanks,
>> >>>> Justin
>> >>
>> >
>>
>>
>
>
>--
>Carlos Rovira
>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fabout.me%2
>Fcarlosrovira&data=02%7C01%7Caharui%40adobe.com%7Cef158780d4714a61dfb908d5
>637d039e%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636524310941764543&s
>data=J7QoUjj3VjvkcYhHaGAdqW3%2B8XU0a2ctG04LorBuYWI%3D&reserved=0
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
Thanks Alex,
I can see it working online :)
I'm trying to test it localy but don't know how to do it.
In order to make the html/css looks good, I need to work localy, please let
me know how yo do it
I installed already ruby, jekyll, etc... and tried to run "bundle exec
jekyll serve" but we don't have Gem file result is:
Could not locate Gemfile or .bundle/ directory
Maybe there's a more easy way to test this.
Carlos
2018-01-19 21:59 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
> OK, I got the CSS to load. You can hit this link:
>
> https://apache.github.io/royale-docs/test/test.html
>
> I'm going to look into automatic TOC generation next. IMO, we should
> decide what kind of header/footer we want not only for the docs on this
> site, but for ASDoc and Olaf's TryItNow as well and start implementing it.
> Like this page, it may not look great right away, but we can iterate
> towards making it look good.
>
> My 2 cents,
> -Alex
>
> On 1/19/18, 1:10 AM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>
> >I'm out of time for today, but I tested templates and jekyll and started
> >to get something to work.
> >
> >https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fapache.gi
> >thub.io%2Froyale-docs%2Ftest%2Ftest.html&data=02%7C01%7Caharui%
> 40adobe.com
> >%7C8d9c2ab112564497fb2608d55f1c7c23%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0
> >%7C0%7C636519498299260185&sdata=2egj2BghYos4ur%
> 2FUSpvN4Vrzh8IOj6rPngvyAJe8
> >ZqM%3D&reserved=0
> >
> >You can see the test/test.md and _layouts/docpage.html in the royals-docs
> >repo. The CSS file didn't load for some reason. Feel free to figure it
> >out or I will look into it tomorrow.
> >
> >HTH,
> >-Alex
> >
> >On 1/18/18, 6:08 PM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
> >
> >>This is for doc, not code so I'm not sure the issue I raised matters.
> >>
> >>That said, I've been reading this [1] and it seems like we should be able
> >>to set up a few templates sort of like we did flex.a.o and not worry so
> >>much about customizing a third-party theme.
> >>
> >>[1]
> >>https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fjekyllrb
> >>.
> >>com%2Fdocs&data=02%7C01%7Caharui%40adobe.com%
> 7C6fca45a581614f01bbd008d55e
> >>e
> >>190da%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
> 7C636519245260410634&sda
> >>t
> >>a=SnZeokcfQXRyaHs338A04ENYTLx%2FWSwo42KPSsA3S9k%3D&reserved=0
> >>
> >>On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com> wrote:
> >>
> >>>Carlos,
> >>>
> >>>I like your findings jeckyll theme doc.
> >>>
> >>>It looks like we may have again similar issue with license as we have in
> >>>MDLExample.
> >>>
> >>>Can someone raise jira for both cases? Alex raises question on legal
> >>>couple
> >>>of days ago. No responses. Let's not wait block us with it - push things
> >>>forward. Jira could be better to do this.
> >>>
> >>>Thanks,
> >>>Piotr
> >>>
> >>>On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
> >>>wrote:
> >>>
> >>>> Hi,
> >>>>
> >>>> > I think this looks very good and seems to be responsive
> >>>> >
> >>>> >
> >>>>[1]https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fmist
> >>>>i
> >>>>c
> >>>>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.com
> %
> >>>>7
> >>>>C
> >>>>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0
> >>>>%
> >>>>7
> >>>>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%
> 2FpwSfe9bxwJd6N%2BmnyMC0pK%
> >>>>2
> >>>>F
> >>>>EepY8o%3D&reserved=0
> >>>> > [2]
> >>>>https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fgithub
> >>>>.
> >>>>c
> >>>>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com
> %7C9c1
> >>>>6
> >>>>8
> >>>>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%
> >>>>7
> >>>>C
> >>>>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%
> 2BzoXqck04VV68TxcIKFs%
> >>>>3
> >>>>D
> >>>>&reserved=0
> >>>>
> >>>> From a quick look this contains CSS code licensed under CC-BY-3.0
> >>>>(looks
> >>>> like it comes from bootstrap docs). That may or may not be an issue,
> >>>> depending on the current conversation around this on legal discuss,
> >>>>and
> >>>> what you want to do with it.
> >>>>
> >>>> Thanks,
> >>>> Justin
> >>
> >
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
OK, I got the CSS to load. You can hit this link:
https://apache.github.io/royale-docs/test/test.html
I'm going to look into automatic TOC generation next. IMO, we should
decide what kind of header/footer we want not only for the docs on this
site, but for ASDoc and Olaf's TryItNow as well and start implementing it.
Like this page, it may not look great right away, but we can iterate
towards making it look good.
My 2 cents,
-Alex
On 1/19/18, 1:10 AM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>I'm out of time for today, but I tested templates and jekyll and started
>to get something to work.
>
>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapache.gi
>thub.io%2Froyale-docs%2Ftest%2Ftest.html&data=02%7C01%7Caharui%40adobe.com
>%7C8d9c2ab112564497fb2608d55f1c7c23%7Cfa7b1b5a7b34438794aed2c178decee1%7C0
>%7C0%7C636519498299260185&sdata=2egj2BghYos4ur%2FUSpvN4Vrzh8IOj6rPngvyAJe8
>ZqM%3D&reserved=0
>
>You can see the test/test.md and _layouts/docpage.html in the royals-docs
>repo. The CSS file didn't load for some reason. Feel free to figure it
>out or I will look into it tomorrow.
>
>HTH,
>-Alex
>
>On 1/18/18, 6:08 PM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>
>>This is for doc, not code so I'm not sure the issue I raised matters.
>>
>>That said, I've been reading this [1] and it seems like we should be able
>>to set up a few templates sort of like we did flex.a.o and not worry so
>>much about customizing a third-party theme.
>>
>>[1]
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fjekyllrb
>>.
>>com%2Fdocs&data=02%7C01%7Caharui%40adobe.com%7C6fca45a581614f01bbd008d55e
>>e
>>190da%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636519245260410634&sda
>>t
>>a=SnZeokcfQXRyaHs338A04ENYTLx%2FWSwo42KPSsA3S9k%3D&reserved=0
>>
>>On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com> wrote:
>>
>>>Carlos,
>>>
>>>I like your findings jeckyll theme doc.
>>>
>>>It looks like we may have again similar issue with license as we have in
>>>MDLExample.
>>>
>>>Can someone raise jira for both cases? Alex raises question on legal
>>>couple
>>>of days ago. No responses. Let's not wait block us with it - push things
>>>forward. Jira could be better to do this.
>>>
>>>Thanks,
>>>Piotr
>>>
>>>On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
>>>wrote:
>>>
>>>> Hi,
>>>>
>>>> > I think this looks very good and seems to be responsive
>>>> >
>>>> >
>>>>[1]https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmist
>>>>i
>>>>c
>>>>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.com%
>>>>7
>>>>C
>>>>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178decee1%7C0
>>>>%
>>>>7
>>>>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%2FpwSfe9bxwJd6N%2BmnyMC0pK%
>>>>2
>>>>F
>>>>EepY8o%3D&reserved=0
>>>> > [2]
>>>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub
>>>>.
>>>>c
>>>>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com%7C9c1
>>>>6
>>>>8
>>>>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>>>>7
>>>>C
>>>>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%2BzoXqck04VV68TxcIKFs%
>>>>3
>>>>D
>>>>&reserved=0
>>>>
>>>> From a quick look this contains CSS code licensed under CC-BY-3.0
>>>>(looks
>>>> like it comes from bootstrap docs). That may or may not be an issue,
>>>> depending on the current conversation around this on legal discuss,
>>>>and
>>>> what you want to do with it.
>>>>
>>>> Thanks,
>>>> Justin
>>
>
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
I'm out of time for today, but I tested templates and jekyll and started
to get something to work.
https://apache.github.io/royale-docs/test/test.html
You can see the test/test.md and _layouts/docpage.html in the royals-docs
repo. The CSS file didn't load for some reason. Feel free to figure it
out or I will look into it tomorrow.
HTH,
-Alex
On 1/18/18, 6:08 PM, "Alex Harui" <ah...@adobe.com.INVALID> wrote:
>This is for doc, not code so I'm not sure the issue I raised matters.
>
>That said, I've been reading this [1] and it seems like we should be able
>to set up a few templates sort of like we did flex.a.o and not worry so
>much about customizing a third-party theme.
>
>[1]
>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fjekyllrb.
>com%2Fdocs&data=02%7C01%7Caharui%40adobe.com%7C6fca45a581614f01bbd008d55ee
>190da%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636519245260410634&sdat
>a=SnZeokcfQXRyaHs338A04ENYTLx%2FWSwo42KPSsA3S9k%3D&reserved=0
>
>On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com> wrote:
>
>>Carlos,
>>
>>I like your findings jeckyll theme doc.
>>
>>It looks like we may have again similar issue with license as we have in
>>MDLExample.
>>
>>Can someone raise jira for both cases? Alex raises question on legal
>>couple
>>of days ago. No responses. Let's not wait block us with it - push things
>>forward. Jira could be better to do this.
>>
>>Thanks,
>>Piotr
>>
>>On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
>>wrote:
>>
>>> Hi,
>>>
>>> > I think this looks very good and seems to be responsive
>>> >
>>> >
>>>[1]https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmisti
>>>c
>>>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.com%7
>>>C
>>>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%
>>>7
>>>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%2FpwSfe9bxwJd6N%2BmnyMC0pK%2
>>>F
>>>EepY8o%3D&reserved=0
>>> > [2]
>>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.
>>>c
>>>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com%7C9c16
>>>8
>>>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7
>>>C
>>>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%2BzoXqck04VV68TxcIKFs%3
>>>D
>>>&reserved=0
>>>
>>> From a quick look this contains CSS code licensed under CC-BY-3.0
>>>(looks
>>> like it comes from bootstrap docs). That may or may not be an issue,
>>> depending on the current conversation around this on legal discuss, and
>>> what you want to do with it.
>>>
>>> Thanks,
>>> Justin
>
Re: Migrating existing FlexJS documentation to Royale
Posted by OmPrakash Muppirala <bi...@gmail.com>.
Here is how Electron does it with Github pages:
Documentation result page: https://electronjs.org/docs/api/accelerator
Source code:
https://github.com/electron/electron/blob/master/docs/api/accelerator.md
Some documentation on how this works:
https://github.com/electron/electronjs.org/blob/master/CONTRIBUTING.md#documentation
On Thu, Jan 18, 2018 at 6:08 PM, Alex Harui <ah...@adobe.com.invalid>
wrote:
> This is for doc, not code so I'm not sure the issue I raised matters.
>
> That said, I've been reading this [1] and it seems like we should be able
> to set up a few templates sort of like we did flex.a.o and not worry so
> much about customizing a third-party theme.
>
> [1] https://jekyllrb.com/docs
>
> On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com> wrote:
>
> >Carlos,
> >
> >I like your findings jeckyll theme doc.
> >
> >It looks like we may have again similar issue with license as we have in
> >MDLExample.
> >
> >Can someone raise jira for both cases? Alex raises question on legal
> >couple
> >of days ago. No responses. Let's not wait block us with it - push things
> >forward. Jira could be better to do this.
> >
> >Thanks,
> >Piotr
> >
> >On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
> >wrote:
> >
> >> Hi,
> >>
> >> > I think this looks very good and seems to be responsive
> >> >
> >> >
> >>[1]https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fmistic
> >>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.com
> %7C
> >>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7
> >>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%
> 2FpwSfe9bxwJd6N%2BmnyMC0pK%2F
> >>EepY8o%3D&reserved=0
> >> > [2]
> >>https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fgithub.c
> >>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com
> %7C9c168
> >>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C
> >>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%
> 2BzoXqck04VV68TxcIKFs%3D
> >>&reserved=0
> >>
> >> From a quick look this contains CSS code licensed under CC-BY-3.0 (looks
> >> like it comes from bootstrap docs). That may or may not be an issue,
> >> depending on the current conversation around this on legal discuss, and
> >> what you want to do with it.
> >>
> >> Thanks,
> >> Justin
>
>
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
This is for doc, not code so I'm not sure the issue I raised matters.
That said, I've been reading this [1] and it seems like we should be able
to set up a few templates sort of like we did flex.a.o and not worry so
much about customizing a third-party theme.
[1] https://jekyllrb.com/docs
On 1/18/18, 5:28 PM, "Piotr Zarzycki" <pi...@gmail.com> wrote:
>Carlos,
>
>I like your findings jeckyll theme doc.
>
>It looks like we may have again similar issue with license as we have in
>MDLExample.
>
>Can someone raise jira for both cases? Alex raises question on legal
>couple
>of days ago. No responses. Let's not wait block us with it - push things
>forward. Jira could be better to do this.
>
>Thanks,
>Piotr
>
>On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com>
>wrote:
>
>> Hi,
>>
>> > I think this looks very good and seems to be responsive
>> >
>> >
>>[1]https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmistic
>>100.github.io%2Fjekyll-bootstrap-doc&data=02%7C01%7Caharui%40adobe.com%7C
>>9c168d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7
>>C0%7C636519220978547047&sdata=cUfWYBGYEBBEd%2FpwSfe9bxwJd6N%2BmnyMC0pK%2F
>>EepY8o%3D&reserved=0
>> > [2]
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.c
>>om%2Fallejo%2Fjekyll-docs-theme&data=02%7C01%7Caharui%40adobe.com%7C9c168
>>d0de9074f2fc06108d55edbea4f%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C
>>636519220978547047&sdata=hY3xQXdzTO8RFF7COWVNJtd%2BzoXqck04VV68TxcIKFs%3D
>>&reserved=0
>>
>> From a quick look this contains CSS code licensed under CC-BY-3.0 (looks
>> like it comes from bootstrap docs). That may or may not be an issue,
>> depending on the current conversation around this on legal discuss, and
>> what you want to do with it.
>>
>> Thanks,
>> Justin
Re: Migrating existing FlexJS documentation to Royale
Posted by Piotr Zarzycki <pi...@gmail.com>.
Carlos,
I like your findings jeckyll theme doc.
It looks like we may have again similar issue with license as we have in
MDLExample.
Can someone raise jira for both cases? Alex raises question on legal couple
of days ago. No responses. Let's not wait block us with it - push things
forward. Jira could be better to do this.
Thanks,
Piotr
On Fri, Jan 19, 2018, 02:08 Justin Mclean <ju...@classsoftware.com> wrote:
> Hi,
>
> > I think this looks very good and seems to be responsive
> >
> > [1]http://mistic100.github.io/jekyll-bootstrap-doc
> > [2] https://github.com/allejo/jekyll-docs-theme
>
> From a quick look this contains CSS code licensed under CC-BY-3.0 (looks
> like it comes from bootstrap docs). That may or may not be an issue,
> depending on the current conversation around this on legal discuss, and
> what you want to do with it.
>
> Thanks,
> Justin
Re: Migrating existing FlexJS documentation to Royale
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> I think this looks very good and seems to be responsive
>
> [1]http://mistic100.github.io/jekyll-bootstrap-doc
> [2] https://github.com/allejo/jekyll-docs-theme
From a quick look this contains CSS code licensed under CC-BY-3.0 (looks like it comes from bootstrap docs). That may or may not be an issue, depending on the current conversation around this on legal discuss, and what you want to do with it.
Thanks,
Justin
Re: Migrating existing FlexJS documentation to Royale
Posted by Andrew Wetmore <co...@gmail.com>.
Yes, that looks fine.
On Thu, Jan 18, 2018 at 8:30 PM, Carlos Rovira <ca...@apache.org>
wrote:
> Hi This is another one [1] based in MIT. Check girhub repo [2]
>
> I think this looks very good and seems to be responsive
>
>
> [1]http://mistic100.github.io/jekyll-bootstrap-doc
> [2] https://github.com/allejo/jekyll-docs-theme
>
>
>
>
> 2018-01-19 1:22 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>
> > Hi Dave,
> >
> > FWIS there, this is the website, with info about how to develop, mailing
> > list, support. For me this match our current website right?, but I think,
> > not the documentation of the project. do you have a link to the
> > documentation to see how is done?
> >
> > 2018-01-19 0:57 GMT+01:00 Dave Fisher <da...@comcast.net>:
> >
> >> Hi -
> >>
> >> I’m sure you guys will figure it out. Here is how Apache OpenOffice did
> >> it about 6 years ago using the Apache CMS. (Now discouraged, but
> possible)
> >> Markdown is good and you can do something complex. Take a look.
> >>
> >> https://openoffice.apache.org/website-local.html
> >>
> >> Note that the OpenOffice.org site existed for 10 years before it was
> >> donated to the ASF. The old html is reskinned by the build site. The
> mdtext
> >> is placed into the template to generate html.
> >>
> >> Regards,
> >> Dave
> >>
> >> On Jan 18, 2018, at 3:47 PM, Carlos Rovira <ca...@apache.org>
> >> wrote:
> >>
> >> Hi Alex,
> >>
> >> 2018-01-19 0:44 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
> >>
> >> 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?
> >>
> >>
> >> I hope so, still playing with GitHub pages and themes. This is all new
> for
> >> me.
> >>
> >>
> >>
> >>
> >> -Alex
> >>
> >> On 1/18/18, 3:36 PM, "carlos.rovira@gmail.com on behalf of Carlos
> Rovira"
> >> <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
> >>
> >> 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 <co...@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%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
> >>
> >>
> >>
> >>
> >>
> >> --
> >> Carlos Rovira
> >> http://about.me/carlosrovira
> >>
> >>
> >>
> >
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
> >
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
Hi This is another one [1] based in MIT. Check girhub repo [2]
I think this looks very good and seems to be responsive
[1]http://mistic100.github.io/jekyll-bootstrap-doc
[2] https://github.com/allejo/jekyll-docs-theme
2018-01-19 1:22 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> Hi Dave,
>
> FWIS there, this is the website, with info about how to develop, mailing
> list, support. For me this match our current website right?, but I think,
> not the documentation of the project. do you have a link to the
> documentation to see how is done?
>
> 2018-01-19 0:57 GMT+01:00 Dave Fisher <da...@comcast.net>:
>
>> Hi -
>>
>> I’m sure you guys will figure it out. Here is how Apache OpenOffice did
>> it about 6 years ago using the Apache CMS. (Now discouraged, but possible)
>> Markdown is good and you can do something complex. Take a look.
>>
>> https://openoffice.apache.org/website-local.html
>>
>> Note that the OpenOffice.org site existed for 10 years before it was
>> donated to the ASF. The old html is reskinned by the build site. The mdtext
>> is placed into the template to generate html.
>>
>> Regards,
>> Dave
>>
>> On Jan 18, 2018, at 3:47 PM, Carlos Rovira <ca...@apache.org>
>> wrote:
>>
>> Hi Alex,
>>
>> 2018-01-19 0:44 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
>>
>> 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?
>>
>>
>> I hope so, still playing with GitHub pages and themes. This is all new for
>> me.
>>
>>
>>
>>
>> -Alex
>>
>> On 1/18/18, 3:36 PM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
>> <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
>>
>> 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 <co...@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%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
>>
>>
>>
>>
>>
>> --
>> Carlos Rovira
>> http://about.me/carlosrovira
>>
>>
>>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
Hi Dave,
FWIS there, this is the website, with info about how to develop, mailing
list, support. For me this match our current website right?, but I think,
not the documentation of the project. do you have a link to the
documentation to see how is done?
2018-01-19 0:57 GMT+01:00 Dave Fisher <da...@comcast.net>:
> Hi -
>
> I’m sure you guys will figure it out. Here is how Apache OpenOffice did it
> about 6 years ago using the Apache CMS. (Now discouraged, but possible)
> Markdown is good and you can do something complex. Take a look.
>
> https://openoffice.apache.org/website-local.html
>
> Note that the OpenOffice.org site existed for 10 years before it was
> donated to the ASF. The old html is reskinned by the build site. The mdtext
> is placed into the template to generate html.
>
> Regards,
> Dave
>
> On Jan 18, 2018, at 3:47 PM, Carlos Rovira <ca...@apache.org>
> wrote:
>
> Hi Alex,
>
> 2018-01-19 0:44 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
>
> 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?
>
>
> I hope so, still playing with GitHub pages and themes. This is all new for
> me.
>
>
>
>
> -Alex
>
> On 1/18/18, 3:36 PM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
> <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
>
> 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 <co...@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%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
>
>
>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Migrating existing FlexJS documentation to Royale
Posted by Dave Fisher <da...@comcast.net>.
Hi -
I’m sure you guys will figure it out. Here is how Apache OpenOffice did it about 6 years ago using the Apache CMS. (Now discouraged, but possible) Markdown is good and you can do something complex. Take a look.
https://openoffice.apache.org/website-local.html <https://openoffice.apache.org/website-local.html>
Note that the OpenOffice.org site existed for 10 years before it was donated to the ASF. The old html is reskinned by the build site. The mdtext is placed into the template to generate html.
Regards,
Dave
> On Jan 18, 2018, at 3:47 PM, Carlos Rovira <ca...@apache.org> wrote:
>
> Hi Alex,
>
> 2018-01-19 0:44 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
>
>> 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?
>>
>
> I hope so, still playing with GitHub pages and themes. This is all new for
> me.
>
>
>
>>
>> -Alex
>>
>> On 1/18/18, 3:36 PM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
>> <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
>>>
>>>> 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 <co...@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%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
>>
>>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
Hi Alex,
2018-01-19 0:44 GMT+01:00 Alex Harui <ah...@adobe.com.invalid>:
> 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?
>
I hope so, still playing with GitHub pages and themes. This is all new for
me.
>
> -Alex
>
> On 1/18/18, 3:36 PM, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
> <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
> >
> >> 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 <co...@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%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
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Migrating existing FlexJS documentation to Royale
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
One option you might want to look into is using this [1] and using maven to build the site and auto publish when changes are made in GitHub via jenkins. We’re doing this on the PLC4X incubating project [2] (so it’s still a work in progress), it's not using markdown but is using asiidoc which is quite simple and similar in concept [3] which GitHub also supports. [4]
Thanks,
Justin
1. https://github.com/andriusvelykis/reflow-maven-skin <https://github.com/andriusvelykis/reflow-maven-skin>
2. http://plc4x.incubator.apache.org/developers/website.html <http://plc4x.incubator.apache.org/developers/website.html>
3. https://raw.githubusercontent.com/apache/incubator-plc4x/master/src/site/asciidoc/index.adoc <https://raw.githubusercontent.com/apache/incubator-plc4x/master/src/site/asciidoc/index.adoc>
4. https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74 <https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74>
Re: Migrating existing FlexJS documentation to Royale
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
> please check this link for licenses [1] and let me know if is ok for us to use this theme as base
I would double check carefully from a quick look it contains a number of differently licensed components including ALv2, MIT and BSD licensed files.(Which should all be all fine) There also mention of GPL which is category X but in this case it’s dual licenses so is OK. Would also be nice to know the license / ip provenance of any icons, images and fonts.
Thanks,
Justin
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
@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 <co...@gmail.com>:
> 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 <ah...@adobe.com.invalid>
> 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, "carlos.rovira@gmail.com on behalf of Carlos
> Rovira"
> > <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
> > >
> > >> 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 <co...@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%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
Re: Migrating existing FlexJS documentation to Royale
Posted by Andrew Wetmore <co...@gmail.com>.
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 <ah...@adobe.com.invalid>
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, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
> <carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
> >
> >> 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 <co...@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%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/
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
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, "carlos.rovira@gmail.com on behalf of Carlos Rovira"
<carlos.rovira@gmail.com on behalf of carlosrovira@apache.org> 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 <ah...@adobe.com.invalid>:
>
>> 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 <co...@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%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
Re: Migrating existing FlexJS documentation to Royale
Posted by Andrew Wetmore <co...@gmail.com>.
Hi, Alex:
As you were writing your note, I was posting this on
https://github.com/apache/royale-asjs/issues/110
I am thinking about a structure for our documentation that helps people who
are new to Royale move into using the framework with satisfaction, and that
helps people who are already working with it find the helpful hint they
need to solve a particular problem. Structuring our documentation so people
can move through it without getting lost or disheartened
I think a good model for the sort of index we need is this one [1] for
Adobe Flex. It leads you along from installing and getting started, through
a quick build of a basic app, through concepts and features, and on to the
complexities that an enterprise-grade application would have to deal with.
Obviously not all of this material is relevant to Royale. At the moment I
am just enjoying the way the topics are organized and lead the reader
forward.
I think I will start to set up a possible index in a Google Doc and open it
up to comments and suggestions.
[1] https://help.adobe.com/en_US/flex/using/index.html
> I've been thinking that we don't want to directly copy the FlexJS pages to
> > GH Pages.
>
I agree. However, some of that material represents low-hanging fruit that
gives us a way to provide at least some documentation within the next few
weeks or months.
> I think the question for
> > you is how much time you have and what you would like to do with your
> > time.
>
I work as a freelance editor and writer, and I have some "interesting"
clients who need a lot of attention, so I can give this effort up to ten
hours a week.
> 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.
>
That may be a way to get the best use out of me, while extracting the best
wisdom from you and others who actually know how Royale works and should
work.
> >
> > 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.
>
Yes...However, the folks who do the majority of the posting here may not
realize how scary you seem to others who are just feeling their way. There
are terms, topics, and approaches that are in common play but that a lot of
people just do not understand yet.
>
>
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
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 <ah...@adobe.com.invalid>:
> 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 <co...@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%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
http://about.me/carlosrovira
Re: Migrating existing FlexJS documentation to Royale
Posted by Alex Harui <ah...@adobe.com.INVALID>.
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 <co...@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
Re: Migrating existing FlexJS documentation to Royale
Posted by Carlos Rovira <ca...@apache.org>.
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 <co...@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://cwiki.apache.org/confluence/display/FLEX/Flex+JS
>
> 2. https://github.com/olafkrueger/flexjs-docs/wiki
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>
--
Carlos Rovira
http://about.me/carlosrovira