royale-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Harbs <harbs.li...@gmail.com>
Subject Re: Github Pages (was Re: Github wikis)
Date Wed, 04 Oct 2017 09:55:59 GMT
Thanks.

The structure there and a lot of the content is great.

We should definitely copy it into docs. We should probably figure out the best way to write
the docs and get started… ;-)

I just added a link to his wiki from the docs page for now.

Does anyone think we need a wiki for the docs repo?

Harbs
> On Oct 4, 2017, at 10:07 AM, Piotr Zarzycki <piotrzarzycki21@gmail.com> wrote:
> 
> Here you go -> https://github.com/ok-at-github/flexjs-docs/wiki
> 
> Thanks,
> Piotr
> 
> 2017-10-04 9:04 GMT+02:00 Harbs <harbs.lists@gmail.com>:
> 
>> I can’t find Olaf’s wiki. Remind me of the URL?
>> 
>>> On Oct 4, 2017, at 9:59 AM, Piotr Zarzycki <piotrzarzycki21@gmail.com>
>> wrote:
>>> 
>>> Thanks Alex. I'm just asking cause I was thinking where I can start with
>>> all of that. I believe that documentation is our true weak point.
>>> 
>>> Harbs do you have some plans in case of the docs ? Do you think that
>> Olaf's
>>> work can be used ?
>>> 
>>> Piotr
>>> 
>>> 2017-10-04 8:54 GMT+02:00 Harbs <harbs.lists@gmail.com <mailto:
>> harbs.lists@gmail.com>>:
>>> 
>>>> I believe we can have it available at a different URL (i.e.
>>>> royalesdk.org/docs <http://royalesdk.org/docs> <
>> http://royalesdk.org/docs <http://royalesdk.org/docs>>) using CNAME
>> entries:
>>>> https://help.github.com/articles/using-a-custom-
>> domain-with-github-pages/ <https://help.github.com/
>> articles/using-a-custom-domain-with-github-pages/>
>>>> <https://help.github.com/articles/using-a-custom-
>> domain-with-github-pages/
>>>>> 
>>>> 
>>>>> On Oct 4, 2017, at 9:48 AM, Alex Harui <aharui@adobe.com.INVALID>
>> wrote:
>>>>> 
>>>>> I'm not sure we have that choice.  I think we are part of an
>> organization
>>>>> and have to use a separate repo.  Maybe that's better because we have
>>>>> several code repos.
>>>>> 
>>>>> The repo is:
>>>>> 
>>>>> https://github.com/apache/royale-docs
>>>>> 
>>>>> When you push it becomes available here:
>>>>> 
>>>>> https://apache.github.io/royale-docs/
>>>>> 
>>>>> Of course, I could be wrong...
>>>>> -Alex
>>>>> 
>>>>> On 10/3/17, 4:46 PM, "omuppi1@gmail.com on behalf of OmPrakash
>>>> Muppirala"
>>>>> <omuppi1@gmail.com on behalf of bigosmallm@gmail.com> wrote:
>>>>> 
>>>>>> This should make things simpler:
>>>>>> https://na01.safelinks.protection.outlook.com/?url=
>>>> https%3A%2F%2Fgithub.co
>>>>>> m%2Fblog%2F2228-simpler-github-pages-publishing&data=
>>>> 02%7C01%7C%7Cdfa4e446
>>>>>> 61f04aca4c1a08d50ad92538%7Cfa7b1b5a7b34438794aed2c178de
>>>> cee1%7C0%7C0%7C6364
>>>>>> 26850111393184&sdata=6FAJXFa81NJY%2FG7FHdKpbnZq3N8arcYV1reW1uDWl
>>>> VQ%3D&rese
>>>>>> rved=0
>>>>>> 
>>>>>> Thanks,
>>>>>> Om
>>>>>> 
>>>>>> On Tue, Oct 3, 2017 at 2:57 PM, Alex Harui <aharui@adobe.com.invalid>
>>>>>> wrote:
>>>>>> 
>>>>>>> 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%7Cdfa4e44661f04aca4c1a08d50ad9
>>>> 2538%7Cfa7b
>>>>>>> 1b5a7b34438794aed2c178decee1%7C0%7C0%7C636426850111393184&
>>>> sdata=0KYVTdYNd
>>>>>>> hKvtS%2B3Ny28BrSOUjdZWdxFcLXkyO4T3wY%3D&reserved=0>
>>>>>>> 
>>>>>>> ________________________________
>>>>>>> From: Harbs <harbs.lists@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 <aharui@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" <aharui@adobe.com.INVALID>
wrote:
>>>>>>>> 
>>>>>>>>> OK, put in a request for royale-docs.
>>>>>>>>> 
>>>>>>>>> On 10/3/17, 1:07 AM, "Piotr Zarzycki" <piotrzarzycki21@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.lists@gmail.com>:
>>>>>>>>>> 
>>>>>>>>>>> royale-docs is good.
>>>>>>>>>>> 
>>>>>>>>>>>> On Oct 3, 2017, at 9:36 AM, OmPrakash Muppirala
>>>>>>>>>>> <bigosmallm@gmail.com>
>>>>>>>>>>> wrote:
>>>>>>>>>>>> 
>>>>>>>>>>>> I prefer royale-docs
>>>>>>>>>>>> 
>>>>>>>>>>>> Thanks,
>>>>>>>>>>>> Om
>>>>>>>>>>>> 
>>>>>>>>>>>> On Oct 2, 2017 11:04 PM, "Alex Harui" <aharui@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" <aharui@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.lists@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
>> <pent@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.lists@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: http://www.linkedin.com/piotrzarzycki <
>> http://www.linkedin.com/piotrzarzycki>
>>> <https://pl.linkedin.com/in/piotr-zarzycki-92a53552 <
>> https://pl.linkedin.com/in/piotr-zarzycki-92a53552>>
>>> 
>>> GitHub: https://github.com/piotrzarzycki21 <https://github.com/
>> piotrzarzycki21>
>> 
> 
> 
> 
> -- 
> 
> 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


Mime
View raw message