Hi, I started work on a Quick Start guide [1] to bridge the gap between the README (source setup and build) and any in-depth documentation.
It will simply be the steps I took to get a project compiling on my machine. I had to gather the information from various places and I thought it'd be nice if other newbies like me didn't have to dig as deep, but could set up and execute their local dev installation in a reasonable amount of time. EdB 1: https://github.com/apache/royale-asjs/wiki On Tue, Oct 3, 2017 at 10: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://github.com/ok-at-github/flexjs-docs/wiki > > 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: http://www.linkedin.com/piotrzarzycki > <https://pl.linkedin.com/in/piotr-zarzycki-92a53552> > > GitHub: https://github.com/piotrzarzycki21 > -- Ix Multimedia Software Jan Luykenstraat 27 3521 VB Utrecht T. 06-51952295 I. www.ixsoftware.nl