You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@royale.apache.org by Carlos Rovira <ca...@apache.org> on 2019/08/22 10:35:16 UTC

Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Hi,

while adding yesterday all "Where to go from here" sections in all blog
examples, I found that Royale docs need a sub menu in the sidebar with some
royale important concepts.

So after "*Get Started*" and before "*Component Sets*" I think we need
something like a "*Fundamental Concepts*" (maybe this title is not the best
and others can get other that match better, I'll try to think in other that
fits better too. I try to refer to "Core Concepts" or a "Technology
features" here).

Is what a user should need to know just after finish "Get Started" guide
and a hello world...know the tools avaialble in the royale arsenal, know
that they have available things like binding, states, modules...

In this submenu we need to cover the things that are still not covered in
the docs and others that are covered but seems a bit lost in places
difficult to find or that are not the best way where a user should find it,
or try to search for it.

Options will be all core concepts:

 - *Fundamental Concepts *
      - *View States* (just created an empty page yesterday)
      - *Data Binding* (page exists too but is empty now and needs to be
relocated)
      - *Modules* (This already exist, I think just need to be relocated)
      - *Externs* (this one was created yesterday by Andrew, again the
problem is still not referenced in menu, and is under "user-interface", but
is more a "core concept" or a "technology feature").
      - *Loading Data* or *Data Access*: This should have a sub menu with
the main ways to access data :
           - *HTTPService*
           - *JSON*
           - *AMF*
           - ...
      - *Metadata*
      - *Styles and CSS*
      - ...  I'm sure there are more to bring here...

For me this is the main missing piece we need to address, and of course
completing not only that menu but many other pages still to fill.

Just one thing to end: In each page after main title the template expect
the next line to be a short subtitle. For example, in the new "Externs"
page y added a new line after title "Use external javascript libraries in
ActiopnScript" So that line is shown in blue and with a bit more size to
match the web style. That line should help a user to quickly understand
what's that page about, since just "Externs" probably will not be of much
help for a beginner.

many pages are still without subtitle, but as we go over all docs, we
should add this lines to help users reaching that pages.

Thanks

-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Carlos Rovira <ca...@apache.org>.
Hi Chris,

thanks. I think your browser's cache is showing you old content. I see
links in the main page are right.


El mié., 28 ago. 2019 a las 10:57, Chris Velevitch (<
chris.velevitch@gmail.com>) escribió:

> On Wed, 28 Aug 2019 at 16:12, Carlos Rovira <ca...@apache.org>
> wrote:
>
> > Where did you find those links? maybe google (maybe bots already didn't
> > notice the change?
>
>
> I found those links by going to the main docs page [1]
>
> [1] https://apache.github.io/royale-docs/
>
> Chris
> --
> Chris Velevitch
> m: 0415 469 095
>


-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Chris Velevitch <ch...@gmail.com>.
On Wed, 28 Aug 2019 at 16:12, Carlos Rovira <ca...@apache.org> wrote:

> Where did you find those links? maybe google (maybe bots already didn't
> notice the change?


I found those links by going to the main docs page [1]

[1] https://apache.github.io/royale-docs/

Chris
--
Chris Velevitch
m: 0415 469 095

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Carlos Rovira <ca...@apache.org>.
Hi Chris,

I moved "Features" section in docs one level up and fix all links. I double
check that I didn't left any link with "welcome/" prefix .
It's about this thread was. I found that instead making a new section we
have already one and was better placed in top level so we can nest pages in
some options.

Where did you find those links? maybe google (maybe bots already didn't
notice the change?

I'm this days making many changes in documentation, you can follow this
work in this repo [1]

[1] https://github.com/apache/royale-docs


El mié., 28 ago. 2019 a las 6:03, Chris Velevitch (<
chris.velevitch@gmail.com>) escribió:

> The following links mentioned don't work:-
>
> - https://apache.github.io/royale-docs/welcome/features-and-concepts.html
> - https://apache.github.io/royale-docs/welcome/features/payg.html
> -
>
> https://apache.github.io/royale-docs/welcome/features/strands-and-beads.html
>
> But I did manage to find the correct working links (just remove the
> "/welcome" from the URL).
>
> Chris
> --
> Chris Velevitch
> m: 0415 469 095
>


-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Chris Velevitch <ch...@gmail.com>.
The following links mentioned don't work:-

- https://apache.github.io/royale-docs/welcome/features-and-concepts.html
- https://apache.github.io/royale-docs/welcome/features/payg.html
-
https://apache.github.io/royale-docs/welcome/features/strands-and-beads.html

But I did manage to find the correct working links (just remove the
"/welcome" from the URL).

Chris
--
Chris Velevitch
m: 0415 469 095

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Carlos Rovira <ca...@codeoscopic.com>.
Excelent Andrew, thanks! :)

El sáb., 24 ago. 2019 a las 21:35, Andrew Wetmore (<co...@gmail.com>)
escribió:

> I have edited the Strands and Beads page for readability.
>
> On Sat, Aug 24, 2019 at 7:55 AM Carlos Rovira <ca...@apache.org>
> wrote:
>
> > Hi Chris,
> >
> > another one page you can need about Strands and Beads:
> >
> >
> >
> https://apache.github.io/royale-docs/welcome/features/strands-and-beads.html
> >
> >
> >
> > El sáb., 24 ago. 2019 a las 10:58, Carlos Rovira (<
> carlosrovira@apache.org
> > >)
> > escribió:
> >
> > > Hi Chris,
> > >
> > > great to see you here :)
> > >
> > > This the actual page on Royale-docs about that concepts:
> > >
> > >
> https://apache.github.io/royale-docs/welcome/features-and-concepts.html
> > >
> > > That links to this other one (more concrete):
> > > https://apache.github.io/royale-docs/welcome/features/payg.html
> > >
> > > Notice that docs are this days in continuous developement.
> > >
> > > You can find short examples like (ala flex examples blog) to get you
> > > started here:
> > >
> > > https://royale.apache.org/category/royale-examples/
> > >
> > > In the Royale-docs I'm trying this days to document the list of beads
> > that
> > > could be used per bead, for example Jewel Button docs is this:
> > >
> > >
> >
> https://apache.github.io/royale-docs/component-sets/jewel/jewel-button.html
> > >
> > > HTH
> > >
> > > Carlos
> > >
> > >
> > >
> > >
> > >
> > >
> > >
> > >
> > > El sáb., 24 ago. 2019 a las 5:48, Chris Velevitch (<
> > > chris.velevitch@gmail.com>) escribió:
> > >
> > >> As a Flex developer exploring Royale, I've come across the terms
> > "beads",
> > >> "strands" and "pay as you go" (PAYG), but I can't find any details,
> > >> documentation or tutorials on them. How do these map into existing
> Flex
> > >> concepts? As for PAYG, as far as I can tell, this is just another name
> > for
> > >> the concept of "tree-shaking" [1] that other javascript frameworks
> > >> have/use.
> > >>
> > >> So, where can I find more information on these?
> > >>
> > >> [1] https://en.wikipedia.org/wiki/Tree_shaking
> > >>
> > >> On Thu, 22 Aug 2019 at 18:35, Carlos Rovira <ca...@apache.org>
> > >> wrote:
> > >>
> > >> > Hi,
> > >> >
> > >> > while adding yesterday all "Where to go from here" sections in all
> > blog
> > >> > examples, I found that Royale docs need a sub menu in the sidebar
> with
> > >> some
> > >> > royale important concepts.
> > >> >
> > >> > So after "*Get Started*" and before "*Component Sets*" I think we
> need
> > >> > something like a "*Fundamental Concepts*" (maybe this title is not
> the
> > >> best
> > >> > and others can get other that match better, I'll try to think in
> other
> > >> that
> > >> > fits better too. I try to refer to "Core Concepts" or a "Technology
> > >> > features" here).
> > >> >
> > >> > Is what a user should need to know just after finish "Get Started"
> > guide
> > >> > and a hello world...know the tools avaialble in the royale arsenal,
> > know
> > >> > that they have available things like binding, states, modules...
> > >> >
> > >> > In this submenu we need to cover the things that are still not
> covered
> > >> in
> > >> > the docs and others that are covered but seems a bit lost in places
> > >> > difficult to find or that are not the best way where a user should
> > find
> > >> it,
> > >> > or try to search for it.
> > >> >
> > >> > Options will be all core concepts:
> > >> >
> > >> >  - *Fundamental Concepts *
> > >> >       - *View States* (just created an empty page yesterday)
> > >> >       - *Data Binding* (page exists too but is empty now and needs
> to
> > be
> > >> > relocated)
> > >> >       - *Modules* (This already exist, I think just need to be
> > >> relocated)
> > >> >       - *Externs* (this one was created yesterday by Andrew, again
> the
> > >> > problem is still not referenced in menu, and is under
> > "user-interface",
> > >> but
> > >> > is more a "core concept" or a "technology feature").
> > >> >       - *Loading Data* or *Data Access*: This should have a sub menu
> > >> with
> > >> > the main ways to access data :
> > >> >            - *HTTPService*
> > >> >            - *JSON*
> > >> >            - *AMF*
> > >> >            - ...
> > >> >       - *Metadata*
> > >> >       - *Styles and CSS*
> > >> >       - ...  I'm sure there are more to bring here...
> > >> >
> > >> > For me this is the main missing piece we need to address, and of
> > course
> > >> > completing not only that menu but many other pages still to fill.
> > >> >
> > >> > Just one thing to end: In each page after main title the template
> > expect
> > >> > the next line to be a short subtitle. For example, in the new
> > "Externs"
> > >> > page y added a new line after title "Use external javascript
> libraries
> > >> in
> > >> > ActiopnScript" So that line is shown in blue and with a bit more
> size
> > to
> > >> > match the web style. That line should help a user to quickly
> > understand
> > >> > what's that page about, since just "Externs" probably will not be of
> > >> much
> > >> > help for a beginner.
> > >> >
> > >> > many pages are still without subtitle, but as we go over all docs,
> we
> > >> > should add this lines to help users reaching that pages.
> > >> >
> > >> > Thanks
> > >> >
> > >> > --
> > >> > Carlos Rovira
> > >> > http://about.me/carlosrovira
> > >> >
> > >>
> > >>
> > >> --
> > >>
> > >>
> > >> Chris
> > >> --
> > >> Chris Velevitch
> > >> m: 0415 469 095
> > >>
> > >
> > >
> > > --
> > > Carlos Rovira
> > > http://about.me/carlosrovira
> > >
> > >
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
>
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>


-- 



Carlos Rovira

Presidente Ejecutivo

M: +34 607 22 60 05

http://www.codeoscopic.com


Conócenos en 1 minuto! <https://avant2.es/#video>


AVISO LEGAL: La información contenida en este correo electrónico, y en su
caso en los documentos adjuntos, es información privilegiada para uso
exclusivo de la persona y/o personas a las que va dirigido. No está
permitido el acceso a este mensaje a cualquier otra persona distinta a los
indicados. Si Usted no es uno de los destinatarios, cualquier duplicación,
reproducción, distribución, así como cualquier uso de la información
contenida en él o cualquiera otra acción u omisión tomada en relación con
el mismo, está prohibida y puede ser ilegal. En dicho caso, por favor,
notifíquelo al remitente y proceda a la eliminación de este correo
electrónico, así como de sus adjuntos si los hubiere. En cumplimiento de la
legislación española vigente en materia de protección de datos de carácter
personal y del RGPD 679/2016 le informamos que sus datos están siendo
objeto de tratamiento por parte de CODEOSCOPIC S.A. con CIFA85677342, con
la finalidad del mantenimiento y gestión de relaciones comerciales y
administrativas. La base jurídica del tratamiento es el interés legítimo de
la empresa. No se prevén cesiones de sus datos, salvo que exista una
obligación legal. Para ejercitar sus derechos puede dirigirse a CODEOSCOPIC
S.A., domiciliada enPaseo de la Habana, 9-11, 28036 de Madrid (MADRID), o
bien por email adpd@codeoscopic.com, con el fin de ejercer sus derechos de
acceso, rectificación, supresión (derecho al olvido), limitación de
tratamiento, portabilidad de los datos, oposición, y a no ser objeto de
decisiones automatizadas, indicando como Asunto: “Derechos Ley Protección
de Datos”, y adjuntando fotocopia de su DNI. Delegado de protección de
datos:dpd@codeoscopic.com

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Andrew Wetmore <co...@gmail.com>.
I have edited the Strands and Beads page for readability.

On Sat, Aug 24, 2019 at 7:55 AM Carlos Rovira <ca...@apache.org>
wrote:

> Hi Chris,
>
> another one page you can need about Strands and Beads:
>
>
> https://apache.github.io/royale-docs/welcome/features/strands-and-beads.html
>
>
>
> El sáb., 24 ago. 2019 a las 10:58, Carlos Rovira (<carlosrovira@apache.org
> >)
> escribió:
>
> > Hi Chris,
> >
> > great to see you here :)
> >
> > This the actual page on Royale-docs about that concepts:
> >
> > https://apache.github.io/royale-docs/welcome/features-and-concepts.html
> >
> > That links to this other one (more concrete):
> > https://apache.github.io/royale-docs/welcome/features/payg.html
> >
> > Notice that docs are this days in continuous developement.
> >
> > You can find short examples like (ala flex examples blog) to get you
> > started here:
> >
> > https://royale.apache.org/category/royale-examples/
> >
> > In the Royale-docs I'm trying this days to document the list of beads
> that
> > could be used per bead, for example Jewel Button docs is this:
> >
> >
> https://apache.github.io/royale-docs/component-sets/jewel/jewel-button.html
> >
> > HTH
> >
> > Carlos
> >
> >
> >
> >
> >
> >
> >
> >
> > El sáb., 24 ago. 2019 a las 5:48, Chris Velevitch (<
> > chris.velevitch@gmail.com>) escribió:
> >
> >> As a Flex developer exploring Royale, I've come across the terms
> "beads",
> >> "strands" and "pay as you go" (PAYG), but I can't find any details,
> >> documentation or tutorials on them. How do these map into existing Flex
> >> concepts? As for PAYG, as far as I can tell, this is just another name
> for
> >> the concept of "tree-shaking" [1] that other javascript frameworks
> >> have/use.
> >>
> >> So, where can I find more information on these?
> >>
> >> [1] https://en.wikipedia.org/wiki/Tree_shaking
> >>
> >> On Thu, 22 Aug 2019 at 18:35, Carlos Rovira <ca...@apache.org>
> >> wrote:
> >>
> >> > Hi,
> >> >
> >> > while adding yesterday all "Where to go from here" sections in all
> blog
> >> > examples, I found that Royale docs need a sub menu in the sidebar with
> >> some
> >> > royale important concepts.
> >> >
> >> > So after "*Get Started*" and before "*Component Sets*" I think we need
> >> > something like a "*Fundamental Concepts*" (maybe this title is not the
> >> best
> >> > and others can get other that match better, I'll try to think in other
> >> that
> >> > fits better too. I try to refer to "Core Concepts" or a "Technology
> >> > features" here).
> >> >
> >> > Is what a user should need to know just after finish "Get Started"
> guide
> >> > and a hello world...know the tools avaialble in the royale arsenal,
> know
> >> > that they have available things like binding, states, modules...
> >> >
> >> > In this submenu we need to cover the things that are still not covered
> >> in
> >> > the docs and others that are covered but seems a bit lost in places
> >> > difficult to find or that are not the best way where a user should
> find
> >> it,
> >> > or try to search for it.
> >> >
> >> > Options will be all core concepts:
> >> >
> >> >  - *Fundamental Concepts *
> >> >       - *View States* (just created an empty page yesterday)
> >> >       - *Data Binding* (page exists too but is empty now and needs to
> be
> >> > relocated)
> >> >       - *Modules* (This already exist, I think just need to be
> >> relocated)
> >> >       - *Externs* (this one was created yesterday by Andrew, again the
> >> > problem is still not referenced in menu, and is under
> "user-interface",
> >> but
> >> > is more a "core concept" or a "technology feature").
> >> >       - *Loading Data* or *Data Access*: This should have a sub menu
> >> with
> >> > the main ways to access data :
> >> >            - *HTTPService*
> >> >            - *JSON*
> >> >            - *AMF*
> >> >            - ...
> >> >       - *Metadata*
> >> >       - *Styles and CSS*
> >> >       - ...  I'm sure there are more to bring here...
> >> >
> >> > For me this is the main missing piece we need to address, and of
> course
> >> > completing not only that menu but many other pages still to fill.
> >> >
> >> > Just one thing to end: In each page after main title the template
> expect
> >> > the next line to be a short subtitle. For example, in the new
> "Externs"
> >> > page y added a new line after title "Use external javascript libraries
> >> in
> >> > ActiopnScript" So that line is shown in blue and with a bit more size
> to
> >> > match the web style. That line should help a user to quickly
> understand
> >> > what's that page about, since just "Externs" probably will not be of
> >> much
> >> > help for a beginner.
> >> >
> >> > many pages are still without subtitle, but as we go over all docs, we
> >> > should add this lines to help users reaching that pages.
> >> >
> >> > Thanks
> >> >
> >> > --
> >> > Carlos Rovira
> >> > http://about.me/carlosrovira
> >> >
> >>
> >>
> >> --
> >>
> >>
> >> Chris
> >> --
> >> Chris Velevitch
> >> m: 0415 469 095
> >>
> >
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
> >
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>


-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Carlos Rovira <ca...@apache.org>.
Hi Chris,

another one page you can need about Strands and Beads:

https://apache.github.io/royale-docs/welcome/features/strands-and-beads.html



El sáb., 24 ago. 2019 a las 10:58, Carlos Rovira (<ca...@apache.org>)
escribió:

> Hi Chris,
>
> great to see you here :)
>
> This the actual page on Royale-docs about that concepts:
>
> https://apache.github.io/royale-docs/welcome/features-and-concepts.html
>
> That links to this other one (more concrete):
> https://apache.github.io/royale-docs/welcome/features/payg.html
>
> Notice that docs are this days in continuous developement.
>
> You can find short examples like (ala flex examples blog) to get you
> started here:
>
> https://royale.apache.org/category/royale-examples/
>
> In the Royale-docs I'm trying this days to document the list of beads that
> could be used per bead, for example Jewel Button docs is this:
>
> https://apache.github.io/royale-docs/component-sets/jewel/jewel-button.html
>
> HTH
>
> Carlos
>
>
>
>
>
>
>
>
> El sáb., 24 ago. 2019 a las 5:48, Chris Velevitch (<
> chris.velevitch@gmail.com>) escribió:
>
>> As a Flex developer exploring Royale, I've come across the terms "beads",
>> "strands" and "pay as you go" (PAYG), but I can't find any details,
>> documentation or tutorials on them. How do these map into existing Flex
>> concepts? As for PAYG, as far as I can tell, this is just another name for
>> the concept of "tree-shaking" [1] that other javascript frameworks
>> have/use.
>>
>> So, where can I find more information on these?
>>
>> [1] https://en.wikipedia.org/wiki/Tree_shaking
>>
>> On Thu, 22 Aug 2019 at 18:35, Carlos Rovira <ca...@apache.org>
>> wrote:
>>
>> > Hi,
>> >
>> > while adding yesterday all "Where to go from here" sections in all blog
>> > examples, I found that Royale docs need a sub menu in the sidebar with
>> some
>> > royale important concepts.
>> >
>> > So after "*Get Started*" and before "*Component Sets*" I think we need
>> > something like a "*Fundamental Concepts*" (maybe this title is not the
>> best
>> > and others can get other that match better, I'll try to think in other
>> that
>> > fits better too. I try to refer to "Core Concepts" or a "Technology
>> > features" here).
>> >
>> > Is what a user should need to know just after finish "Get Started" guide
>> > and a hello world...know the tools avaialble in the royale arsenal, know
>> > that they have available things like binding, states, modules...
>> >
>> > In this submenu we need to cover the things that are still not covered
>> in
>> > the docs and others that are covered but seems a bit lost in places
>> > difficult to find or that are not the best way where a user should find
>> it,
>> > or try to search for it.
>> >
>> > Options will be all core concepts:
>> >
>> >  - *Fundamental Concepts *
>> >       - *View States* (just created an empty page yesterday)
>> >       - *Data Binding* (page exists too but is empty now and needs to be
>> > relocated)
>> >       - *Modules* (This already exist, I think just need to be
>> relocated)
>> >       - *Externs* (this one was created yesterday by Andrew, again the
>> > problem is still not referenced in menu, and is under "user-interface",
>> but
>> > is more a "core concept" or a "technology feature").
>> >       - *Loading Data* or *Data Access*: This should have a sub menu
>> with
>> > the main ways to access data :
>> >            - *HTTPService*
>> >            - *JSON*
>> >            - *AMF*
>> >            - ...
>> >       - *Metadata*
>> >       - *Styles and CSS*
>> >       - ...  I'm sure there are more to bring here...
>> >
>> > For me this is the main missing piece we need to address, and of course
>> > completing not only that menu but many other pages still to fill.
>> >
>> > Just one thing to end: In each page after main title the template expect
>> > the next line to be a short subtitle. For example, in the new "Externs"
>> > page y added a new line after title "Use external javascript libraries
>> in
>> > ActiopnScript" So that line is shown in blue and with a bit more size to
>> > match the web style. That line should help a user to quickly understand
>> > what's that page about, since just "Externs" probably will not be of
>> much
>> > help for a beginner.
>> >
>> > many pages are still without subtitle, but as we go over all docs, we
>> > should add this lines to help users reaching that pages.
>> >
>> > Thanks
>> >
>> > --
>> > Carlos Rovira
>> > http://about.me/carlosrovira
>> >
>>
>>
>> --
>>
>>
>> Chris
>> --
>> Chris Velevitch
>> m: 0415 469 095
>>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
>

-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Carlos Rovira <ca...@apache.org>.
Hi Chris,

great to see you here :)

This the actual page on Royale-docs about that concepts:

https://apache.github.io/royale-docs/welcome/features-and-concepts.html

That links to this other one (more concrete):
https://apache.github.io/royale-docs/welcome/features/payg.html

Notice that docs are this days in continuous developement.

You can find short examples like (ala flex examples blog) to get you
started here:

https://royale.apache.org/category/royale-examples/

In the Royale-docs I'm trying this days to document the list of beads that
could be used per bead, for example Jewel Button docs is this:

https://apache.github.io/royale-docs/component-sets/jewel/jewel-button.html

HTH

Carlos








El sáb., 24 ago. 2019 a las 5:48, Chris Velevitch (<
chris.velevitch@gmail.com>) escribió:

> As a Flex developer exploring Royale, I've come across the terms "beads",
> "strands" and "pay as you go" (PAYG), but I can't find any details,
> documentation or tutorials on them. How do these map into existing Flex
> concepts? As for PAYG, as far as I can tell, this is just another name for
> the concept of "tree-shaking" [1] that other javascript frameworks
> have/use.
>
> So, where can I find more information on these?
>
> [1] https://en.wikipedia.org/wiki/Tree_shaking
>
> On Thu, 22 Aug 2019 at 18:35, Carlos Rovira <ca...@apache.org>
> wrote:
>
> > Hi,
> >
> > while adding yesterday all "Where to go from here" sections in all blog
> > examples, I found that Royale docs need a sub menu in the sidebar with
> some
> > royale important concepts.
> >
> > So after "*Get Started*" and before "*Component Sets*" I think we need
> > something like a "*Fundamental Concepts*" (maybe this title is not the
> best
> > and others can get other that match better, I'll try to think in other
> that
> > fits better too. I try to refer to "Core Concepts" or a "Technology
> > features" here).
> >
> > Is what a user should need to know just after finish "Get Started" guide
> > and a hello world...know the tools avaialble in the royale arsenal, know
> > that they have available things like binding, states, modules...
> >
> > In this submenu we need to cover the things that are still not covered in
> > the docs and others that are covered but seems a bit lost in places
> > difficult to find or that are not the best way where a user should find
> it,
> > or try to search for it.
> >
> > Options will be all core concepts:
> >
> >  - *Fundamental Concepts *
> >       - *View States* (just created an empty page yesterday)
> >       - *Data Binding* (page exists too but is empty now and needs to be
> > relocated)
> >       - *Modules* (This already exist, I think just need to be relocated)
> >       - *Externs* (this one was created yesterday by Andrew, again the
> > problem is still not referenced in menu, and is under "user-interface",
> but
> > is more a "core concept" or a "technology feature").
> >       - *Loading Data* or *Data Access*: This should have a sub menu with
> > the main ways to access data :
> >            - *HTTPService*
> >            - *JSON*
> >            - *AMF*
> >            - ...
> >       - *Metadata*
> >       - *Styles and CSS*
> >       - ...  I'm sure there are more to bring here...
> >
> > For me this is the main missing piece we need to address, and of course
> > completing not only that menu but many other pages still to fill.
> >
> > Just one thing to end: In each page after main title the template expect
> > the next line to be a short subtitle. For example, in the new "Externs"
> > page y added a new line after title "Use external javascript libraries in
> > ActiopnScript" So that line is shown in blue and with a bit more size to
> > match the web style. That line should help a user to quickly understand
> > what's that page about, since just "Externs" probably will not be of much
> > help for a beginner.
> >
> > many pages are still without subtitle, but as we go over all docs, we
> > should add this lines to help users reaching that pages.
> >
> > Thanks
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
>
>
> --
>
>
> Chris
> --
> Chris Velevitch
> m: 0415 469 095
>


-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Sub-Menu in royale-docs: "Fundamental Concepts", "Core Concepts" or "Technology features"

Posted by Chris Velevitch <ch...@gmail.com>.
As a Flex developer exploring Royale, I've come across the terms "beads",
"strands" and "pay as you go" (PAYG), but I can't find any details,
documentation or tutorials on them. How do these map into existing Flex
concepts? As for PAYG, as far as I can tell, this is just another name for
the concept of "tree-shaking" [1] that other javascript frameworks have/use.

So, where can I find more information on these?

[1] https://en.wikipedia.org/wiki/Tree_shaking

On Thu, 22 Aug 2019 at 18:35, Carlos Rovira <ca...@apache.org> wrote:

> Hi,
>
> while adding yesterday all "Where to go from here" sections in all blog
> examples, I found that Royale docs need a sub menu in the sidebar with some
> royale important concepts.
>
> So after "*Get Started*" and before "*Component Sets*" I think we need
> something like a "*Fundamental Concepts*" (maybe this title is not the best
> and others can get other that match better, I'll try to think in other that
> fits better too. I try to refer to "Core Concepts" or a "Technology
> features" here).
>
> Is what a user should need to know just after finish "Get Started" guide
> and a hello world...know the tools avaialble in the royale arsenal, know
> that they have available things like binding, states, modules...
>
> In this submenu we need to cover the things that are still not covered in
> the docs and others that are covered but seems a bit lost in places
> difficult to find or that are not the best way where a user should find it,
> or try to search for it.
>
> Options will be all core concepts:
>
>  - *Fundamental Concepts *
>       - *View States* (just created an empty page yesterday)
>       - *Data Binding* (page exists too but is empty now and needs to be
> relocated)
>       - *Modules* (This already exist, I think just need to be relocated)
>       - *Externs* (this one was created yesterday by Andrew, again the
> problem is still not referenced in menu, and is under "user-interface", but
> is more a "core concept" or a "technology feature").
>       - *Loading Data* or *Data Access*: This should have a sub menu with
> the main ways to access data :
>            - *HTTPService*
>            - *JSON*
>            - *AMF*
>            - ...
>       - *Metadata*
>       - *Styles and CSS*
>       - ...  I'm sure there are more to bring here...
>
> For me this is the main missing piece we need to address, and of course
> completing not only that menu but many other pages still to fill.
>
> Just one thing to end: In each page after main title the template expect
> the next line to be a short subtitle. For example, in the new "Externs"
> page y added a new line after title "Use external javascript libraries in
> ActiopnScript" So that line is shown in blue and with a bit more size to
> match the web style. That line should help a user to quickly understand
> what's that page about, since just "Externs" probably will not be of much
> help for a beginner.
>
> many pages are still without subtitle, but as we go over all docs, we
> should add this lines to help users reaching that pages.
>
> Thanks
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>


-- 


Chris
--
Chris Velevitch
m: 0415 469 095