IMO, flex-docs is for user-facing documentation. IOW, how to use Royale. The repo wikis are for how to be a developer of the code in the wiki. Build instructions, release guides, etc. The wikis won't have very much polish. Most of what is in the Flex Wiki for FlexJS can end up in the repo wikis except the places where we tried to write user-facing documentation.
My 2 cents, -Alex On 10/3/17, 7:57 PM, "Piotr Zarzycki" <piotrzarzyck...@gmail.com> wrote: >Hi, > >I see that we have repo for docs [1] and gh-pages working [2]. I would >like >to start putting somewhere information in the Olaf's structure [3], of >course let's change whatever you think to have better one. > >The question is - Where such things should landed in royale-docs or in >royale-asjs - WIKI tab ? > >[1] >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fapache%2Froyale-docs&data=02%7C01%7C%7C1cc23b20500f41e8c76b08d50ad3a65 >c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426826503113618&sdata=WZ >Osb89uXL3s8nrHjRVSaSkmsuWUyQSxMMJS%2BN9O4Xo%3D&reserved=0 >[2] >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapache.gi >thub.io%2Froyale-docs%2F&data=02%7C01%7C%7C1cc23b20500f41e8c76b08d50ad3a65 >c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426826503113618&sdata=wl >p%2BocJ1mKV6%2BXy8ELZP2u4cWLLSe8NMhmLrFIUMR0g%3D&reserved=0 >[3] >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fok-at-github%2Fflexjs-docs%2Fwiki&data=02%7C01%7C%7C1cc23b20500f41e8c7 >6b08d50ad3a65c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C63642682650311 >3618&sdata=ZKmxBa7gPxIxZof0c4MlzOZktzXDmyj6bgEJmN%2FA0%2BE%3D&reserved=0 > >Thanks, >Piotr > >2017-10-03 23:57 GMT+02:00 Alex Harui <aha...@adobe.com.invalid>: > >> Not sure. I notified infra per their instructions. >> >> Get Outlook for >>Android<https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2F >>aka.ms%2Fghei36&data=02%7C01%7C%7C1cc23b20500f41e8c76b08d50ad3a65c%7Cfa7b >>1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426826503113618&sdata=eJZnrMxUG >>kvlKJxZJZq9COzf2zW4D3%2FpZZuSojPzXy0%3D&reserved=0> >> >> ________________________________ >> From: Harbs <harbs.li...@gmail.com> >> Sent: Tuesday, October 3, 2017 1:46:14 PM >> To: dev@royale.apache.org >> Subject: Re: Github Pages (was Re: Github wikis) >> >> Done. Do I need to make a gh-pages branch? >> >> > On Oct 3, 2017, at 11:35 PM, Alex Harui <aha...@adobe.com.INVALID> >> wrote: >> > >> > Royale-docs has been created. Can someone put in some initial >>content? >> > I'm buried in the rename and don't want to stop to figure out GH >>Pages. >> > Then we ask Infra to hook it up as our project's pages. >> > >> > Thanks, >> > -Alex >> > >> > On 10/3/17, 1:17 PM, "Alex Harui" <aha...@adobe.com.INVALID> wrote: >> > >> >> OK, put in a request for royale-docs. >> >> >> >> On 10/3/17, 1:07 AM, "Piotr Zarzycki" <piotrzarzyck...@gmail.com> >> wrote: >> >> >> >>> Hi Alex, >> >>> >> >>> +1 for royale-docs. If I would like to make something like Olaf [1] >> >>> started >> >>> and move all his already gathered information in that structure >>where >> in >> >>> your opinion guys should it go ? Into the royale-docs as gh pages or >> into >> >>> royale-asjs as Wiki ? >> >>> >> >>> Does anyone is against to have it Olaf's work as an starting point ? >> >>> >> >>> [1] >> >>> https://na01.safelinks.protection.outlook.com/?url= >> https%3A%2F%2Fgithub.c >> >>> o >> >>> m%2Fok-at-github%2Fflexjs-docs%2Fwiki&data=02%7C01%7C% >> 7C88a0571d57dc4f6ed >> >>> 2 >> >>> b708d50a35c2c1%7Cfa7b1b5a7b34438794aed2c178de >> cee1%7C0%7C0%7C6364261483757 >> >>> 2 >> >>> >>6455&sdata=KFmOxwgKRbgCW5LTjF0xy8UG%2B6wPjyc744lJ9KTdy00%3D&reserved=0 >> >>> >> >>> Thanks, >> >>> Piotr >> >>> >> >>> >> >>> 2017-10-03 9:55 GMT+02:00 Harbs <harbs.li...@gmail.com>: >> >>> >> >>>> royale-docs is good. >> >>>> >> >>>>> On Oct 3, 2017, at 9:36 AM, OmPrakash Muppirala >> >>>> <bigosma...@gmail.com> >> >>>> wrote: >> >>>>> >> >>>>> I prefer royale-docs >> >>>>> >> >>>>> Thanks, >> >>>>> Om >> >>>>> >> >>>>> On Oct 2, 2017 11:04 PM, "Alex Harui" <aha...@adobe.com.invalid> >> >>>> wrote: >> >>>>> >> >>>>>> Per Infra: "Pages are not enabled until we have some content to >> >>>> point >> >>>> to. >> >>>>>> Best thing I think is to create a new royale-pages repository (or >> >>>> whatever >> >>>>>> name) and I'll enable it on that - ensure some content in >>'master' >> >>>> branch >> >>>>>> or 'master/docs' . those pages would then be available on >> >>>>>> apache.github.io/royale-pages (or whatever)" >> >>>>>> >> >>>>>> Shall we create a royale-pages repo? Anybody think it should >>have >> >>>> some >> >>>>>> other name? "royale-documentation"? I think it will hold our >> >>>> non-ASDoc >> >>>>>> user documentation. >> >>>>>> >> >>>>>> Thoughts? >> >>>>>> -Alex >> >>>>>> >> >>>>>> On 10/2/17, 11:42 AM, "Alex Harui" <aha...@adobe.com.INVALID> >> wrote: >> >>>>>> >> >>>>>>> I think I learned that Github Pages is not per-repo, it is one >>per >> >>>> Apache >> >>>>>>> Project. >> >>>>>>> >> >>>>>>> It is a bit easier to have one repo per release product. >>Combining >> >>>> repos >> >>>>>>> for a release is a bit of extra work. There should be examples >>in >> >>>> the >> >>>>>>> IDE-friendly artifact. IMO, TourJS would have its own release >> >>>> schedule. >> >>>>>>> >> >>>>>>> My 2 cents, >> >>>>>>> -Alex >> >>>>>>> >> >>>>>>> On 10/2/17, 11:32 AM, "Harbs" <harbs.li...@gmail.com> wrote: >> >>>>>>> >> >>>>>>>> I’d like to setup an example repo so it’ll build a website >>(i.e. >> >>>> Github >> >>>>>>>> Pages) where the samples could be run. It seems similar to >>tourjs >> >>>> in a >> >>>>>>>> way, but different. “Examples” to me is more like a tutorial on >> >>>> how to >> >>>>>>>> use Royale while tourjs is more of a reference of the >>components. >> >>>> They >> >>>>>>>> seem separate and complimentary. >> >>>>>>>> >> >>>>>>>> Harbs >> >>>>>>>> >> >>>>>>>> >> >>>>>>>>> On Oct 2, 2017, at 9:25 PM, Peter Ent <p...@adobe.com.INVALID> >> >>>> wrote: >> >>>>>>>>> >> >>>>>>>>> I have been thinking that examples should be moved from >> >>>> royale-asjs >> >>>> and >> >>>>>>>>> put into its own royals-examples repo and then a wiki for that >> >>>> would >> >>>>>>>>> work >> >>>>>>>>> well. >> >>>>>>>>> >> >>>>>>>>> Maybe the tourjs should be a subdirectory in examples. >> >>>>>>>>> >> >>>>>>>>> ‹peter >> >>>>>>>>> >> >>>>>>>>> On 10/2/17, 2:14 PM, "Harbs" <harbs.li...@gmail.com> wrote: >> >>>>>>>>> >> >>>>>>>>>> INFRA just informed us that Github Wikis are now an option >>and >> >>>> they >> >>>>>>>>>> want >> >>>>>>>>>> to know which repos we want wikis for.[1] >> >>>>>>>>>> >> >>>>>>>>>> royale-asjs and royale-compiler seem like no-brainers. >> >>>>>>>>>> >> >>>>>>>>>> What about royale-typedefs, royale-tourjs and royale-website? >> >>>> Does >> >>>>>>>>>> anyone >> >>>>>>>>>> see a reason for a wiki in those? >> >>>>>>>>>> >> >>>>>>>>>> At what point do folks think we should set up an ³examples² >> >>>> repo? A >> >>>>>>>>>> wiki >> >>>>>>>>>> would probably be appropriate on something like that. >> >>>>>>>>>> >> >>>>>>>>>> Thanks, >> >>>>>>>>>> Harbs >> >>>>>>>>>> >> >>>>>>>>>> >> >>>>>>>>>> [1]https://na01.safelinks.protection.outlook.com/?url= >> >>>>>> https%3A%2F%2Fiss >> >>>>>>>>>> u >> >>>>>>>>>> es >> >>>>>>>>>> >> >>>>>>>>>> .apache.org%2Fjira%2Fbrowse%2FINFRA-15138% >> >>>>>> 3FfocusedCommentId%3D16188401 >> >>>>>>>>>> % >> >>>>>>>>>> 26 >> >>>>>>>>>> >> >>>>>>>>>> page%3Dcom.atlassian.jira.plugin.system.issuetabpanels% >> >>>>>> 3Acomment-tabpan >> >>>>>>>>>> e >> >>>>>>>>>> l% >> >>>>>>>>>> >> >>>>>>>>>> >> >>>> 23comment-16188401&data=02%7C01%7C%7Cf13e83a4f7594535bec608d509c1 >> >>>>>> 76d8%7 >> >>>>>>>>>> C >> >>>>>>>>>> fa >> >>>>>>>>>> >> >>>>>>>>>> 7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636425648884686688& >> >>>>>> sdata=%2FSB >> >>>>>>>>>> h >> >>>>>>>>>> %2 >> >>>>>>>>>> BpyjIfrx%2FcwnFZAxqD%2FGdT3lvte6%2FWItPQDTIqs%3D&reserved=0 >> >>>>>>>>> >> >>>>>>>> >> >>>>>>> >> >>>>>> >> >>>>>> >> >>>> >> >>>> >> >>> >> >>> >> >>> -- >> >>> >> >>> Piotr Zarzycki >> >>> >> >>> mobile: +48 880 859 557 >> >>> skype: zarzycki10 >> >>> >> >>> LinkedIn: >> >>> https://na01.safelinks.protection.outlook.com/?url= >> http%3A%2F%2Fwww.linke >> >>> d >> >>> >>in.com%2Fpiotrzarzycki&data=02%7C01%7C%7C88a0571d57dc4f6ed2b708d50a35 >> c2c1 >> >>> % >> >>> 7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0% >> 7C636426148375726455&sdata=9Iu >> >>> Y >> >>> zi2Xc7Rn%2Fh7fEhdx3%2FZL2zal8uvnWt7%2BA6XPEIU%3D&reserved=0 >> >>> <https://na01.safelinks.protection.outlook.com/?url= >> https%3A%2F%2Fpl.link >> >>> e >> >>> din.com%2Fin%2Fpiotr-zarzycki-92a53552&data=02%7C01%7C% >> 7C88a0571d57dc4f6e >> >>> d >> >>> 2b708d50a35c2c1%7Cfa7b1b5a7b34438794aed2c178de >> cee1%7C0%7C0%7C636426148375 >> >>> 7 >> >>> 26455&sdata=3wTwkWcXwOhMB1ZbnlyTzLL2FJButx >> mx28%2BIbDG80W8%3D&reserved=0> >> >>> >> >>> GitHub: >> >>> https://na01.safelinks.protection.outlook.com/?url= >> https%3A%2F%2Fgithub.c >> >>> o >> >>> m%2Fpiotrzarzycki21&data=02%7C01%7C%7C88a0571d57dc4f6ed2b708d50a35 >> c2c1%7C >> >>> f >> >>> a7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426148375726455&sdata= >> 9yybfI >> >>> 1 >> >>> 8Klsn70VEawLVOTS0Q2lXbuguuBhjDDF1udo%3D&reserved=0 >> >> >> > >> >> > > >-- > >Piotr Zarzycki > >mobile: +48 880 859 557 >skype: zarzycki10 > >LinkedIn: >https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fwww.linked >in.com%2Fpiotrzarzycki&data=02%7C01%7C%7C1cc23b20500f41e8c76b08d50ad3a65c% >7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426826503113618&sdata=36%2 >Fa1I4uygTcNckVwg8MPhSjb36a23UvuV3uafQBa04%3D&reserved=0 ><https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpl.linke >din.com%2Fin%2Fpiotr-zarzycki-92a53552&data=02%7C01%7C%7C1cc23b20500f41e8c >76b08d50ad3a65c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6364268265031 >13618&sdata=X3pnfpbaDVLBaKucf1HVk%2FOdl0x%2BKYa1QDyI2nz33rg%3D&reserved=0> > >GitHub: >https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.co >m%2Fpiotrzarzycki21&data=02%7C01%7C%7C1cc23b20500f41e8c76b08d50ad3a65c%7Cf >a7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426826503113618&sdata=jSImG5X >swEpLX%2BavGfLcTQHvXaGMVE1FQH5OdcvPmdI%3D&reserved=0
