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/02/18 14:52:25 UTC
Migrating or linking to wiki material for user docs?
Hi:
There is user discussion about dealing with circular dependencies when
migrating Flex apps to Royale. There is good material about what this is
and how to deal with it on the wiki [1]. Do I migrate that text into the
help documentation or provide a link to it from the page that talks about
app migration?
The larger question is: what is the long-term status of the wiki? Do we
harvest material out of it, or continue to build it and encourage people to
contribute to it? At the moment it feels a little unreliable because most
of the relevant references are to FlexJS, and the page I am looking at is
stuck down a branch marked as "legacy".
As a reader advocate, I would prefer this important stuff be where the
reader can easily find it. However, if it stays where it is, 90% of the
pages still need to be updated to address Royale realities, even if that
only involves rebranding.
Which way forward?
a
[1] https://cwiki.apache.org/confluence/display/FLEX/Circular+Dependencies
--
Andrew Wetmore
http://cottage14.blogspot.com/
<https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail>
Virus-free.
www.avast.com
<https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail>
<#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
Re: Migrating or linking to wiki material for user docs?
Posted by Andrew Wetmore <co...@gmail.com>.
=So, if its for "users" it goes into royale-docs and is more carefully
=curated/edited. If is about contributing code to Royale it goes in the
=relevant repo and I personally don't care too much about how well-written,
=consistent, and approachable it is.
That is very helpful. I will proceed to migrate and upgrade (with
everyone's help) material in the wiki that will be helpful to those who
plan to use Royale for building things.
a
On Sun, Feb 18, 2018 at 6:35 PM, Alex Harui <ah...@adobe.com.invalid>
wrote:
> IMO, everything in the Flex wiki about FlexJS will be revisited and
> relevant pieces copied or re-written and end up in a Royale repo wiki or
> royale-docs.
> Each major Royale repo should have its own wiki. The wiki should contain
> documentation for folks contributing to the code in that repo via being a
> committer or sending in patches and pull requests. The royale-asjs wiki
> will also contain general useful information for contributing to the
> project in general, such as making releases, reports to the board, etc.
>
> Royale-docs should be the official "book" about Royale.
>
> So, if its for "users" it goes into royale-docs and is more carefully
> curated/edited. If is about contributing code to Royale it goes in the
> relevant repo and I personally don't care too much about how well-written,
> consistent, and approachable it is.
>
> My 2 cents,
> -Alex
>
> On 2/18/18, 6:52 AM, "Andrew Wetmore" <co...@gmail.com> wrote:
>
> >Hi:
> >
> >There is user discussion about dealing with circular dependencies when
> >migrating Flex apps to Royale. There is good material about what this is
> >and how to deal with it on the wiki [1]. Do I migrate that text into the
> >help documentation or provide a link to it from the page that talks about
> >app migration?
> >
> >The larger question is: what is the long-term status of the wiki? Do we
> >harvest material out of it, or continue to build it and encourage people
> >to
> >contribute to it? At the moment it feels a little unreliable because most
> >of the relevant references are to FlexJS, and the page I am looking at is
> >stuck down a branch marked as "legacy".
> >
> >As a reader advocate, I would prefer this important stuff be where the
> >reader can easily find it. However, if it stays where it is, 90% of the
> >pages still need to be updated to address Royale realities, even if that
> >only involves rebranding.
> >
> >Which way forward?
> >
> >a
> >
> >[1]
> >https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fcwiki.apa
> >che.org%2Fconfluence%2Fdisplay%2FFLEX%2FCircular%
> 2BDependencies&data=02%7C
> >01%7Caharui%40adobe.com%7C164e9e229c53494c17fc08d576df
> 3c2c%7Cfa7b1b5a7b344
> >38794aed2c178decee1%7C0%7C0%7C636545623522166735&sdata=
> seoIZmgqYk%2BzvqkuC
> >5yAceOOg9iEAvw4FLAO92XFY18%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%
> 7C164e9e229c53494c17fc08
> >d576df3c2c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
> 7C636545623522166735
> >&sdata=H4%2BYNLXDFeAURNKZmlOVRev9Uz706IlOLVQ5hCdP5lw%3D&reserved=0
> >
> >
> >
> >
> >
> ><https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fwww.avas
> >t.com%2Fsig-email%3Futm_medium%3Demail%26utm_source%
> 3Dlink%26utm_campaign%
> >3Dsig-email%26utm_content%3Dwebmail&data=02%7C01%7Caharui%40adobe.com
> %7C16
> >4e9e229c53494c17fc08d576df3c2c%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%
> >7C636545623522166735&sdata=OLYOXKdoCnxRvnBiYAw1Vo6pKqRXmT
> x6FnE0Oc1ormk%3D&
> >reserved=0>
> >Virus-free.
> >https://na01.safelinks.protection.outlook.com/?url=
> www.avast.com&data=02%7
> >C01%7Caharui%40adobe.com%7C164e9e229c53494c17fc08d576df
> 3c2c%7Cfa7b1b5a7b34
> >438794aed2c178decee1%7C0%7C0%7C636545623522166735&sdata=
> 5qg62EPvweSYhwkFPH
> >mzTIcD1Ge9uqSbEWUjq%2B81gEs%3D&reserved=0
> ><https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fwww.avas
> >t.com%2Fsig-email%3Futm_medium%3Demail%26utm_source%
> 3Dlink%26utm_campaign%
> >3Dsig-email%26utm_content%3Dwebmail&data=02%7C01%7Caharui%40adobe.com
> %7C16
> >4e9e229c53494c17fc08d576df3c2c%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%
> >7C636545623522166735&sdata=OLYOXKdoCnxRvnBiYAw1Vo6pKqRXmT
> x6FnE0Oc1ormk%3D&
> >reserved=0>
> ><#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
>
>
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Migrating or linking to wiki material for user docs?
Posted by Alex Harui <ah...@adobe.com.INVALID>.
IMO, everything in the Flex wiki about FlexJS will be revisited and
relevant pieces copied or re-written and end up in a Royale repo wiki or
royale-docs.
Each major Royale repo should have its own wiki. The wiki should contain
documentation for folks contributing to the code in that repo via being a
committer or sending in patches and pull requests. The royale-asjs wiki
will also contain general useful information for contributing to the
project in general, such as making releases, reports to the board, etc.
Royale-docs should be the official "book" about Royale.
So, if its for "users" it goes into royale-docs and is more carefully
curated/edited. If is about contributing code to Royale it goes in the
relevant repo and I personally don't care too much about how well-written,
consistent, and approachable it is.
My 2 cents,
-Alex
On 2/18/18, 6:52 AM, "Andrew Wetmore" <co...@gmail.com> wrote:
>Hi:
>
>There is user discussion about dealing with circular dependencies when
>migrating Flex apps to Royale. There is good material about what this is
>and how to deal with it on the wiki [1]. Do I migrate that text into the
>help documentation or provide a link to it from the page that talks about
>app migration?
>
>The larger question is: what is the long-term status of the wiki? Do we
>harvest material out of it, or continue to build it and encourage people
>to
>contribute to it? At the moment it feels a little unreliable because most
>of the relevant references are to FlexJS, and the page I am looking at is
>stuck down a branch marked as "legacy".
>
>As a reader advocate, I would prefer this important stuff be where the
>reader can easily find it. However, if it stays where it is, 90% of the
>pages still need to be updated to address Royale realities, even if that
>only involves rebranding.
>
>Which way forward?
>
>a
>
>[1]
>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcwiki.apa
>che.org%2Fconfluence%2Fdisplay%2FFLEX%2FCircular%2BDependencies&data=02%7C
>01%7Caharui%40adobe.com%7C164e9e229c53494c17fc08d576df3c2c%7Cfa7b1b5a7b344
>38794aed2c178decee1%7C0%7C0%7C636545623522166735&sdata=seoIZmgqYk%2BzvqkuC
>5yAceOOg9iEAvw4FLAO92XFY18%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%7C164e9e229c53494c17fc08
>d576df3c2c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636545623522166735
>&sdata=H4%2BYNLXDFeAURNKZmlOVRev9Uz706IlOLVQ5hCdP5lw%3D&reserved=0
>
>
>
>
>
><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.avas
>t.com%2Fsig-email%3Futm_medium%3Demail%26utm_source%3Dlink%26utm_campaign%
>3Dsig-email%26utm_content%3Dwebmail&data=02%7C01%7Caharui%40adobe.com%7C16
>4e9e229c53494c17fc08d576df3c2c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>7C636545623522166735&sdata=OLYOXKdoCnxRvnBiYAw1Vo6pKqRXmTx6FnE0Oc1ormk%3D&
>reserved=0>
>Virus-free.
>https://na01.safelinks.protection.outlook.com/?url=www.avast.com&data=02%7
>C01%7Caharui%40adobe.com%7C164e9e229c53494c17fc08d576df3c2c%7Cfa7b1b5a7b34
>438794aed2c178decee1%7C0%7C0%7C636545623522166735&sdata=5qg62EPvweSYhwkFPH
>mzTIcD1Ge9uqSbEWUjq%2B81gEs%3D&reserved=0
><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.avas
>t.com%2Fsig-email%3Futm_medium%3Demail%26utm_source%3Dlink%26utm_campaign%
>3Dsig-email%26utm_content%3Dwebmail&data=02%7C01%7Caharui%40adobe.com%7C16
>4e9e229c53494c17fc08d576df3c2c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>7C636545623522166735&sdata=OLYOXKdoCnxRvnBiYAw1Vo6pKqRXmTx6FnE0Oc1ormk%3D&
>reserved=0>
><#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>