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 2018/01/14 19:42:12 UTC
Github Documentation (Re: Apache Royale website is live!!)
Changing subject
About Github documentation, I think we should start migrating what we have
already at Apache Wiki in FlexJS.
For Example this:
https://cwiki.apache.org/confluence/display/FLEX/FlexJS+Basic+components
Would be a great start
About the documentation tag, I see you already introduced a bug report,
Maybe others want to comment as well regarding this issue
thanks!
> 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
>>
>>
>> I am thinking about where to record and track tasks for future
>> documentation. I see that our project in GitHub has a "documentation" tag
>> with no active bug reports. Is that where I should enter, not just
>> documentation bug issues, but to-do stuff like "create a blog entry on
>> TOPIC X"? Or is there some other system for tracking stuff like that?
>>
>> --
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Olaf Krueger <ma...@olafkrueger.net>.
Hi Carlos,
>But there's no such file, so my main question is, is royale-docs a Github
>pages repo so I can customize it with a Github Pages Theme?
From my understanding, any GitHub repo is able to process/provide GitHub
pages.
>Add the following to your site's _config.yml:
IIRIC, GitHub pages uses Jekyll as default static site generator.
This _config.yml is a Jekyll file [1].
I guess we have to setup our repo at first in order to use one of those
(Jekyll?) templates [2][3][4].
Of yourse, I could be wrong.
I would help with this, but after I took some time in order to test the
release approval stuff I'd like to continue with the TryItNow app at first
;-)
Thanks,
Olaf
[1] https://jekyllrb.com/docs/configuration/
[2] https://help.github.com/categories/customizing-github-pages/
[3]
https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser/
[4]
https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
--
Sent from: http://apache-royale-development.20373.n8.nabble.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Olaf Krueger <ma...@olafkrueger.net>.
Hi Piotr,
>I don't think we need Wiki on the docs repository.
I agree that we should start directly with GH pages.
>We just need to correct all the things which you have on your repo
It is not so much content at the end.
I guess we have to rewrite it anyway, so don't care about it ;-)
>It is less pleasent write mark down only without preview. - If there is
some tool...
https://github.com/planetjekyll/awesome-jekyll-editors
Thanks,
Olaf
--
Sent from: http://apache-royale-development.20373.n8.nabble.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Alex Harui <ah...@adobe.com.INVALID>.
We decided a while back to use GH Pages instead of a wiki for our
user-facing documentation. Royale is part of the Apache organization on
GH, so there might be more restrictions on what we can and can't do.
AIUI, it is all HTML and CSS in the end. I'm not opposed to switching to
using Jekyll and MarkDown as long as we can add regular HTML files, as
well as other CSS and JS files which might be generated by Royale to the
GH Pages web site.
Thanks,
-Alex
On 1/16/18, 5:34 AM, "Olaf Krueger" <ma...@olafkrueger.net> wrote:
>Hi Carlos,
>
>>I think we should have control over this in order to modify to our needs
>and not having to bother
>>anyone for something so easy
>
>Agree!
>
>
>>I need to know now, how I can tweak the theme to our needs
>This should do the trick [1]
>
>Thanks for working on this!!
>
>Olaf
>
>[1]
>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhelp.gith
>ub.com%2Farticles%2Fcustomizing-css-and-html-in-your-jekyll-theme%2F&data=
>02%7C01%7Caharui%40adobe.com%7C309fdf7eef9c4f84f64c08d55ce5f44c%7Cfa7b1b5a
>7b34438794aed2c178decee1%7C0%7C0%7C636517065116363687&sdata=kNtFlcYO2ukNYL
>d654tQmV0J0GCaS5reROk7Zozlcb8%3D&reserved=0
>
>
>
>
>
>--
>Sent from:
>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fapache-roy
>ale-development.20373.n8.nabble.com%2F&data=02%7C01%7Caharui%40adobe.com%7
>C309fdf7eef9c4f84f64c08d55ce5f44c%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7
>C0%7C636517065116363687&sdata=1Mm16vSGSNHaSU7khN0IsT1Hm%2FGpKyGVDmkoa3meTw
>8%3D&reserved=0
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Olaf Krueger <ma...@olafkrueger.net>.
Hi Carlos,
>I think we should have control over this in order to modify to our needs
and not having to bother
>anyone for something so easy
Agree!
>I need to know now, how I can tweak the theme to our needs
This should do the trick [1]
Thanks for working on this!!
Olaf
[1]
https://help.github.com/articles/customizing-css-and-html-in-your-jekyll-theme/
--
Sent from: http://apache-royale-development.20373.n8.nabble.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Carlos Rovira <ca...@apache.org>.
Cayman is a Github official theme. So I suppose is totally right to use it
as an starting point.
But in the end: We don't want to use Cayman!, we want to create a theme
that has our branding (fonts, colors and some image backgrounds)
2018-01-16 13:23 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
> Carlos,
>
> What's with the license of Cayman. Maybe we should choose some theme
> compatible with Apache ? Only one from the list seems to be, but I'm not an
> expert [1]
>
> [1] https://github.com/pages-themes/primer
>
> Thanks, Piotr
>
>
> 2018-01-16 13:14 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>
> > Just created the ticket here:
> >
> > https://issues.apache.org/jira/browse/INFRA-15845
> >
> > 2018-01-16 13:03 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> >
> > > Hi,
> > >
> > > yes, I think the best way is to use markdown, GitHub pages and some
> > > template (e.j: Cayman) as an starting point to change styles to match
> or
> > > Royale website styles
> > > As we all doesn't have experience, I'll try to investigate and talk
> with
> > > infra to see if they need to make some tweak.
> > >
> > > I want to put all the things inlace so Andrew can work on docs more
> > easily
> > >
> > > Thanks all fro your thoughts! :)
> > >
> > > 2018-01-16 11:13 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
> > >
> > >> There is possibility that we may have to ask infra to switch something
> > >> etc.
> > >> I don't think we need Wiki on the docs repository. It should be
> possible
> > >> make pull requests to that repository by anyone.
> > >>
> > >> We just need to correct all the things which you have on your repo,
> than
> > >> make transformation to the GitHub pages.
> > >>
> > >> Later we can proceed straight in our repo. It is less pleasent write
> > mark
> > >> down only without preview. - If there is some tool which allows have
> > >> preview without Wiki, we can even transform current state of your
> > >> repository to GitHub pages.
> > >>
> > >>
> > >> 2018-01-16 11:03 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
> > >>
> > >> > >Do you know the way how to do this ?
> > >> >
> > >> > My understanding is that Jekyll supports MarkDown out of the box.
> > >> > If that's the case, each Wiki article could easily be reused with
> > GitHub
> > >> > pages.
> > >> > As I started with my FlexJS docs Wiki the goal was to start easily
> > using
> > >> > the
> > >> > Wiki and porting it later to GitHub pages.
> > >> >
> > >> > BTW: From my opionion, we definately should use Markdown in order to
> > >> write
> > >> > the documentation cause it simplifies things a lot.
> > >> >
> > >> >
> > >> > >If someone can help with that it would be great.
> > >> >
> > >> > If I would entirely know how it works I would share my knowledge and
> > >> would
> > >> > help of course ;-)
> > >> > I'll try to I find some time to investigate a bit more...
> > >> >
> > >> > Thanks,
> > >> > Olaf
> > >> >
> > >> >
> > >> >
> > >> >
> > >> >
> > >> > --
> > >> > Sent from: http://apache-royale-development.20373.n8.nabble.com/
> > >> >
> > >>
> > >>
> > >>
> > >> --
> > >>
> > >> Piotr Zarzycki
> > >>
> > >> Patreon: *https://www.patreon.com/piotrzarzycki
> > >> <https://www.patreon.com/piotrzarzycki>*
> > >>
> > >
> > >
> > >
> > > --
> > > Carlos Rovira
> > > http://about.me/carlosrovira
> > >
> > >
> >
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
>
>
>
> --
>
> Piotr Zarzycki
>
> Patreon: *https://www.patreon.com/piotrzarzycki
> <https://www.patreon.com/piotrzarzycki>*
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Piotr Zarzycki <pi...@gmail.com>.
Carlos,
What's with the license of Cayman. Maybe we should choose some theme
compatible with Apache ? Only one from the list seems to be, but I'm not an
expert [1]
[1] https://github.com/pages-themes/primer
Thanks, Piotr
2018-01-16 13:14 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> Just created the ticket here:
>
> https://issues.apache.org/jira/browse/INFRA-15845
>
> 2018-01-16 13:03 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>
> > Hi,
> >
> > yes, I think the best way is to use markdown, GitHub pages and some
> > template (e.j: Cayman) as an starting point to change styles to match or
> > Royale website styles
> > As we all doesn't have experience, I'll try to investigate and talk with
> > infra to see if they need to make some tweak.
> >
> > I want to put all the things inlace so Andrew can work on docs more
> easily
> >
> > Thanks all fro your thoughts! :)
> >
> > 2018-01-16 11:13 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
> >
> >> There is possibility that we may have to ask infra to switch something
> >> etc.
> >> I don't think we need Wiki on the docs repository. It should be possible
> >> make pull requests to that repository by anyone.
> >>
> >> We just need to correct all the things which you have on your repo, than
> >> make transformation to the GitHub pages.
> >>
> >> Later we can proceed straight in our repo. It is less pleasent write
> mark
> >> down only without preview. - If there is some tool which allows have
> >> preview without Wiki, we can even transform current state of your
> >> repository to GitHub pages.
> >>
> >>
> >> 2018-01-16 11:03 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
> >>
> >> > >Do you know the way how to do this ?
> >> >
> >> > My understanding is that Jekyll supports MarkDown out of the box.
> >> > If that's the case, each Wiki article could easily be reused with
> GitHub
> >> > pages.
> >> > As I started with my FlexJS docs Wiki the goal was to start easily
> using
> >> > the
> >> > Wiki and porting it later to GitHub pages.
> >> >
> >> > BTW: From my opionion, we definately should use Markdown in order to
> >> write
> >> > the documentation cause it simplifies things a lot.
> >> >
> >> >
> >> > >If someone can help with that it would be great.
> >> >
> >> > If I would entirely know how it works I would share my knowledge and
> >> would
> >> > help of course ;-)
> >> > I'll try to I find some time to investigate a bit more...
> >> >
> >> > Thanks,
> >> > Olaf
> >> >
> >> >
> >> >
> >> >
> >> >
> >> > --
> >> > Sent from: http://apache-royale-development.20373.n8.nabble.com/
> >> >
> >>
> >>
> >>
> >> --
> >>
> >> Piotr Zarzycki
> >>
> >> Patreon: *https://www.patreon.com/piotrzarzycki
> >> <https://www.patreon.com/piotrzarzycki>*
> >>
> >
> >
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
> >
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
--
Piotr Zarzycki
Patreon: *https://www.patreon.com/piotrzarzycki
<https://www.patreon.com/piotrzarzycki>*
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Carlos Rovira <ca...@apache.org>.
Hi,
I created my own test repo, and is very easy.
https://github.com/carlosrovira/royale-pages-test/blob/master/README.md
https://carlosrovira.github.io/royale-pages-test/
So we need for infra to config the Github repo. I think we should have
control over this in order to modify to our needs and not having to bother
anyone for something so easy
In the other hand, I applied the theme with the theme chooser, I need to
know now, how I can tweak the theme to our needs
2018-01-16 13:14 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> Just created the ticket here:
>
> https://issues.apache.org/jira/browse/INFRA-15845
>
> 2018-01-16 13:03 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>
>> Hi,
>>
>> yes, I think the best way is to use markdown, GitHub pages and some
>> template (e.j: Cayman) as an starting point to change styles to match or
>> Royale website styles
>> As we all doesn't have experience, I'll try to investigate and talk with
>> infra to see if they need to make some tweak.
>>
>> I want to put all the things inlace so Andrew can work on docs more
>> easily
>>
>> Thanks all fro your thoughts! :)
>>
>> 2018-01-16 11:13 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
>>
>>> There is possibility that we may have to ask infra to switch something
>>> etc.
>>> I don't think we need Wiki on the docs repository. It should be possible
>>> make pull requests to that repository by anyone.
>>>
>>> We just need to correct all the things which you have on your repo, than
>>> make transformation to the GitHub pages.
>>>
>>> Later we can proceed straight in our repo. It is less pleasent write mark
>>> down only without preview. - If there is some tool which allows have
>>> preview without Wiki, we can even transform current state of your
>>> repository to GitHub pages.
>>>
>>>
>>> 2018-01-16 11:03 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
>>>
>>> > >Do you know the way how to do this ?
>>> >
>>> > My understanding is that Jekyll supports MarkDown out of the box.
>>> > If that's the case, each Wiki article could easily be reused with
>>> GitHub
>>> > pages.
>>> > As I started with my FlexJS docs Wiki the goal was to start easily
>>> using
>>> > the
>>> > Wiki and porting it later to GitHub pages.
>>> >
>>> > BTW: From my opionion, we definately should use Markdown in order to
>>> write
>>> > the documentation cause it simplifies things a lot.
>>> >
>>> >
>>> > >If someone can help with that it would be great.
>>> >
>>> > If I would entirely know how it works I would share my knowledge and
>>> would
>>> > help of course ;-)
>>> > I'll try to I find some time to investigate a bit more...
>>> >
>>> > Thanks,
>>> > Olaf
>>> >
>>> >
>>> >
>>> >
>>> >
>>> > --
>>> > Sent from: http://apache-royale-development.20373.n8.nabble.com/
>>> >
>>>
>>>
>>>
>>> --
>>>
>>> Piotr Zarzycki
>>>
>>> Patreon: *https://www.patreon.com/piotrzarzycki
>>> <https://www.patreon.com/piotrzarzycki>*
>>>
>>
>>
>>
>> --
>> Carlos Rovira
>> http://about.me/carlosrovira
>>
>>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Carlos Rovira <ca...@apache.org>.
Just created the ticket here:
https://issues.apache.org/jira/browse/INFRA-15845
2018-01-16 13:03 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> Hi,
>
> yes, I think the best way is to use markdown, GitHub pages and some
> template (e.j: Cayman) as an starting point to change styles to match or
> Royale website styles
> As we all doesn't have experience, I'll try to investigate and talk with
> infra to see if they need to make some tweak.
>
> I want to put all the things inlace so Andrew can work on docs more easily
>
> Thanks all fro your thoughts! :)
>
> 2018-01-16 11:13 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
>
>> There is possibility that we may have to ask infra to switch something
>> etc.
>> I don't think we need Wiki on the docs repository. It should be possible
>> make pull requests to that repository by anyone.
>>
>> We just need to correct all the things which you have on your repo, than
>> make transformation to the GitHub pages.
>>
>> Later we can proceed straight in our repo. It is less pleasent write mark
>> down only without preview. - If there is some tool which allows have
>> preview without Wiki, we can even transform current state of your
>> repository to GitHub pages.
>>
>>
>> 2018-01-16 11:03 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
>>
>> > >Do you know the way how to do this ?
>> >
>> > My understanding is that Jekyll supports MarkDown out of the box.
>> > If that's the case, each Wiki article could easily be reused with GitHub
>> > pages.
>> > As I started with my FlexJS docs Wiki the goal was to start easily using
>> > the
>> > Wiki and porting it later to GitHub pages.
>> >
>> > BTW: From my opionion, we definately should use Markdown in order to
>> write
>> > the documentation cause it simplifies things a lot.
>> >
>> >
>> > >If someone can help with that it would be great.
>> >
>> > If I would entirely know how it works I would share my knowledge and
>> would
>> > help of course ;-)
>> > I'll try to I find some time to investigate a bit more...
>> >
>> > Thanks,
>> > Olaf
>> >
>> >
>> >
>> >
>> >
>> > --
>> > Sent from: http://apache-royale-development.20373.n8.nabble.com/
>> >
>>
>>
>>
>> --
>>
>> Piotr Zarzycki
>>
>> Patreon: *https://www.patreon.com/piotrzarzycki
>> <https://www.patreon.com/piotrzarzycki>*
>>
>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Carlos Rovira <ca...@apache.org>.
Hi,
yes, I think the best way is to use markdown, GitHub pages and some
template (e.j: Cayman) as an starting point to change styles to match or
Royale website styles
As we all doesn't have experience, I'll try to investigate and talk with
infra to see if they need to make some tweak.
I want to put all the things inlace so Andrew can work on docs more easily
Thanks all fro your thoughts! :)
2018-01-16 11:13 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
> There is possibility that we may have to ask infra to switch something etc.
> I don't think we need Wiki on the docs repository. It should be possible
> make pull requests to that repository by anyone.
>
> We just need to correct all the things which you have on your repo, than
> make transformation to the GitHub pages.
>
> Later we can proceed straight in our repo. It is less pleasent write mark
> down only without preview. - If there is some tool which allows have
> preview without Wiki, we can even transform current state of your
> repository to GitHub pages.
>
>
> 2018-01-16 11:03 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
>
> > >Do you know the way how to do this ?
> >
> > My understanding is that Jekyll supports MarkDown out of the box.
> > If that's the case, each Wiki article could easily be reused with GitHub
> > pages.
> > As I started with my FlexJS docs Wiki the goal was to start easily using
> > the
> > Wiki and porting it later to GitHub pages.
> >
> > BTW: From my opionion, we definately should use Markdown in order to
> write
> > the documentation cause it simplifies things a lot.
> >
> >
> > >If someone can help with that it would be great.
> >
> > If I would entirely know how it works I would share my knowledge and
> would
> > help of course ;-)
> > I'll try to I find some time to investigate a bit more...
> >
> > Thanks,
> > Olaf
> >
> >
> >
> >
> >
> > --
> > Sent from: http://apache-royale-development.20373.n8.nabble.com/
> >
>
>
>
> --
>
> Piotr Zarzycki
>
> Patreon: *https://www.patreon.com/piotrzarzycki
> <https://www.patreon.com/piotrzarzycki>*
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Piotr Zarzycki <pi...@gmail.com>.
There is possibility that we may have to ask infra to switch something etc.
I don't think we need Wiki on the docs repository. It should be possible
make pull requests to that repository by anyone.
We just need to correct all the things which you have on your repo, than
make transformation to the GitHub pages.
Later we can proceed straight in our repo. It is less pleasent write mark
down only without preview. - If there is some tool which allows have
preview without Wiki, we can even transform current state of your
repository to GitHub pages.
2018-01-16 11:03 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
> >Do you know the way how to do this ?
>
> My understanding is that Jekyll supports MarkDown out of the box.
> If that's the case, each Wiki article could easily be reused with GitHub
> pages.
> As I started with my FlexJS docs Wiki the goal was to start easily using
> the
> Wiki and porting it later to GitHub pages.
>
> BTW: From my opionion, we definately should use Markdown in order to write
> the documentation cause it simplifies things a lot.
>
>
> >If someone can help with that it would be great.
>
> If I would entirely know how it works I would share my knowledge and would
> help of course ;-)
> I'll try to I find some time to investigate a bit more...
>
> Thanks,
> Olaf
>
>
>
>
>
> --
> Sent from: http://apache-royale-development.20373.n8.nabble.com/
>
--
Piotr Zarzycki
Patreon: *https://www.patreon.com/piotrzarzycki
<https://www.patreon.com/piotrzarzycki>*
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Olaf Krueger <ma...@olafkrueger.net>.
>Do you know the way how to do this ?
My understanding is that Jekyll supports MarkDown out of the box.
If that's the case, each Wiki article could easily be reused with GitHub
pages.
As I started with my FlexJS docs Wiki the goal was to start easily using the
Wiki and porting it later to GitHub pages.
BTW: From my opionion, we definately should use Markdown in order to write
the documentation cause it simplifies things a lot.
>If someone can help with that it would be great.
If I would entirely know how it works I would share my knowledge and would
help of course ;-)
I'll try to I find some time to investigate a bit more...
Thanks,
Olaf
--
Sent from: http://apache-royale-development.20373.n8.nabble.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Piotr Zarzycki <pi...@gmail.com>.
Olaf,
Ad. 1) I personally don't want wiki for documentation. That is only the
proposition to use wiki on your repository in order to simplify things and
investigate whether we can transform it to the GitHub pages. Do you know
the way how to do this ?
Ad. 2) I think Carlos need help with run even simple Hello World using
Jekyll on our royale-docs. If someone can help with that it would be great.
Thanks, Piotr
2018-01-16 10:46 GMT+01:00 Olaf Krueger <ma...@olafkrueger.net>:
> Hi,
>
> >How do we create navigation that shows up on each page of the
> >documentation
>
> To be clear:
> There are two common ways of creating a documentation by using GitHub:
>
> 1) Using the GitHub Wiki
> 2) Using GitHub pages
>
> 1)
> Here the navigation is provided by using the Wikis' sidebar.
> You have to put some Marddown into the _Sidebar in order to build the
> navigation structure.
> All articles has to be written in MarkDown.
> I noticed that our Royale-docs repo does not provide a Wiki.
> If we would like to use it we have to enable it at first. Does anybody know
> how to enable the Wiki?
> The main drawback of the Wiki is, that (as far as I know) we can't use pull
> request. There are revisons for particular articles, but it feels that a
> lot
> of things are done behind the scene.
> Moreover I guess we can't customize the look and feel.
>
> 2)
> This is they way Carlos would like to go.
> With GitHub pages you can use e.g. Jekyll, which is a static site
> generator.
> This produces a more sophisticated look and feel.
> We have to grab a Jekyll template and customize it and make it all work.
> When all is in place we could start with creating content.
> The entire code/content could be managed in the same way as any other code
> repository.
>
> I guess we would like to go with GitHub pages?
>
> Hope this helps,
> Olaf
>
>
>
>
>
>
> --
> Sent from: http://apache-royale-development.20373.n8.nabble.com/
>
--
Piotr Zarzycki
Patreon: *https://www.patreon.com/piotrzarzycki
<https://www.patreon.com/piotrzarzycki>*
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Olaf Krueger <ma...@olafkrueger.net>.
Hi,
>How do we create navigation that shows up on each page of the
>documentation
To be clear:
There are two common ways of creating a documentation by using GitHub:
1) Using the GitHub Wiki
2) Using GitHub pages
1)
Here the navigation is provided by using the Wikis' sidebar.
You have to put some Marddown into the _Sidebar in order to build the
navigation structure.
All articles has to be written in MarkDown.
I noticed that our Royale-docs repo does not provide a Wiki.
If we would like to use it we have to enable it at first. Does anybody know
how to enable the Wiki?
The main drawback of the Wiki is, that (as far as I know) we can't use pull
request. There are revisons for particular articles, but it feels that a lot
of things are done behind the scene.
Moreover I guess we can't customize the look and feel.
2)
This is they way Carlos would like to go.
With GitHub pages you can use e.g. Jekyll, which is a static site generator.
This produces a more sophisticated look and feel.
We have to grab a Jekyll template and customize it and make it all work.
When all is in place we could start with creating content.
The entire code/content could be managed in the same way as any other code
repository.
I guess we would like to go with GitHub pages?
Hope this helps,
Olaf
--
Sent from: http://apache-royale-development.20373.n8.nabble.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Piotr Zarzycki <pi...@gmail.com>.
Andrew,
I think that's the trick. If you put all the things into file with
extension *.md in theory there are special engines who turns into github
pages.
I see that Carlos have problem with launching it.
Maybe we should proceed differently.
1) Make changes and new things on Olaf's github Wiki - you have there
previews etc.
2) Explore possibility to automatically convert each wiki page to *.md files
3) Try to run github pages.
Thoughts?
Thanks, Piotr
On Tue, Jan 16, 2018, 01:50 Andrew Wetmore <co...@gmail.com> wrote:
> As far as I can tell, the github documentation pages are in HTML, not
> markdown. To add MD pages I would need to have push permission. I can
> create new pages within the github editor in HTML and create a pull request
> for those. At the moment I am just testing out what I can do and what the
> result looks like.
>
> On Mon, Jan 15, 2018 at 8:16 PM, Andrew Wetmore <co...@gmail.com>
> wrote:
>
> > How do we create navigation that shows up on each page of the
> > documentation, as we have in the FlexJS part of the Flex wiki [1] or on
> > Olaf's wiki [2], or in some other way? People will need to be able to
> > browse without backing up to the top page of the help project over and
> over
> > again.
> >
> > Thanks!
> >
> > a
> >
> > [1] https://cwiki.apache.org/confluence/pages/viewpage.
> > action?pageId=34013930
> >
> > [2] https://github.com/olafkrueger/flexjs-docs/wiki
> >
> > On Mon, Jan 15, 2018 at 3:14 PM, Carlos Rovira <ca...@apache.org>
> > wrote:
> >
> >> Hi I'm looking how to add a basic theme to royale-docs. But I'm not sure
> >> our repo "royale-docs" is a Github pages repo.
> >>
> >> I'm trying this [1]
> >>
> >> And says
> >>
> >> Add the following to your site's _config.yml:
> >>
> >> But there's no such file, so my main question is, is royale-docs a
> Github
> >> pages repo so I can customize it with a Github Pages Theme?
> >> (if this could be done, I'll customize it to get the royale website
> basic
> >> look and feel
> >>
> >> Hope someone could help me on this, so I could setup all in order to let
> >> Andrew work more easily
> >>
> >> Thanks
> >>
> >>
> >> [1] https://github.com/pages-themes/cayman
> >>
> >> 2018-01-14 23:08 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> >>
> >> > Hi,
> >> >
> >> > I think is a good idea to make some branding here. It should be very
> >> easy.
> >> > We should check [1].
> >> > An example of this is [2]. So, I could see how a GitHub theme is done
> >> and
> >> > prepare one with some graphics, fonts and CSS from our website
> >> > But I think this could be done in parallel to the migration and maybe
> as
> >> > the theme is ready some changes must be done in the set of migrated
> >> pages
> >> > So for me the right place to do this work is [3] and publish in [4]
> >> >
> >> > [1] https://pages.github.com/themes/
> >> > [2] https://pages-themes.github.io/merlot/
> >> > [3] https://github.com/apache/royale-docs
> >> > [4] https://apache.github.io/royale-docs/
> >> >
> >> >
> >> > 2018-01-14 22:07 GMT+01:00 Piotr Zarzycki <piotrzarzycki21@gmail.com
> >:
> >> >
> >> >> We have separate repository here [1]. Whatever you push there it will
> >> be
> >> >> automatically deployed here [2].
> >> >> In what format it should be - well I always thought that it can be
> >> bunch
> >> >> of
> >> >> github pages - Which we later display it somehow.
> >> >>
> >> >> If you look into some of the page in Olaf's starting point repository
> >> [3]
> >> >> -
> >> >> You can change each of that page as an file for example
> >> "Hello-world.md"
> >> >> with exactly the same markers as it is on the wiki.
> >> >>
> >> >> In whatever direction you will go it will be good I think so, we can
> >> later
> >> >> change all of that to most suitable way.
> >> >>
> >> >> [1] https://github.com/apache/royale-docs
> >> >> [2] https://apache.github.io/royale-docs/
> >> >> [3] https://github.com/olafkrueger/flexjs-docs/wiki/Hello-world
> >> >>
> >> >> Thanks, Piotr
> >> >>
> >> >> 2018-01-14 21:54 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> >> >>
> >> >> > Yes, that's an excellent beginning and structure.
> >> >> >
> >> >> > Royale will need a branded knowledge base. Will that be integrated
> in
> >> >> the
> >> >> > website, or a wiki hosted on github or somewhere else?
> >> >> >
> >> >> > a
> >> >> >
> >> >> > On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <
> >> >> piotrzarzycki21@gmail.com
> >> >> > >
> >> >> > wrote:
> >> >> >
> >> >> > > Hi,
> >> >> > >
> >> >> > > We have started that effort here [1]. That was quite good
> starting
> >> >> point.
> >> >> > >
> >> >> > > [1] https://github.com/olafkrueger/flexjs-docs/wiki
> >> >> > >
> >> >> > > Thanks, Piotr
> >> >> > >
> >> >> > > 2018-01-14 20:42 GMT+01:00 Carlos Rovira <
> carlosrovira@apache.org
> >> >:
> >> >> > >
> >> >> > > > Changing subject
> >> >> > > >
> >> >> > > > About Github documentation, I think we should start migrating
> >> what
> >> >> we
> >> >> > > have
> >> >> > > > already at Apache Wiki in FlexJS.
> >> >> > > >
> >> >> > > > For Example this:
> >> >> > > > https://cwiki.apache.org/confluence/display/FLEX/
> >> >> > FlexJS+Basic+components
> >> >> > > >
> >> >> > > > Would be a great start
> >> >> > > >
> >> >> > > > About the documentation tag, I see you already introduced a bug
> >> >> report,
> >> >> > > > Maybe others want to comment as well regarding this issue
> >> >> > > >
> >> >> > > > thanks!
> >> >> > > >
> >> >> > > >
> >> >> > > >
> >> >> > > > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <
> cottage14@gmail.com
> >> >:
> >> >> > > > >>
> >> >> > > > >>
> >> >> > > > >> I am thinking about where to record and track tasks for
> future
> >> >> > > > >> documentation. I see that our project in GitHub has a
> >> >> > "documentation"
> >> >> > > > tag
> >> >> > > > >> with no active bug reports. Is that where I should enter,
> not
> >> >> just
> >> >> > > > >> documentation bug issues, but to-do stuff like "create a
> blog
> >> >> entry
> >> >> > on
> >> >> > > > >> TOPIC X"? Or is there some other system for tracking stuff
> >> like
> >> >> > that?
> >> >> > > > >>
> >> >> > > > >> --
> >> >> > > > Carlos Rovira
> >> >> > > > http://about.me/carlosrovira
> >> >> > > >
> >> >> > >
> >> >> > >
> >> >> > >
> >> >> > > --
> >> >> > >
> >> >> > > Piotr Zarzycki
> >> >> > >
> >> >> > > Patreon: *https://www.patreon.com/piotrzarzycki
> >> >> > > <https://www.patreon.com/piotrzarzycki>*
> >> >> > >
> >> >> >
> >> >> >
> >> >> >
> >> >> > --
> >> >> > Andrew Wetmore
> >> >> >
> >> >> > http://cottage14.blogspot.com/
> >> >> >
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >>
> >> >> Piotr Zarzycki
> >> >>
> >> >> Patreon: *https://www.patreon.com/piotrzarzycki
> >> >> <https://www.patreon.com/piotrzarzycki>*
> >> >>
> >> >
> >> >
> >> >
> >> > --
> >> > Carlos Rovira
> >> > http://about.me/carlosrovira
> >> >
> >> >
> >>
> >>
> >> --
> >> Carlos Rovira
> >> http://about.me/carlosrovira
> >>
> >
> >
> >
> > --
> > Andrew Wetmore
> >
> > http://cottage14.blogspot.com/
> >
> >
> >
> >
> >
>
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Andrew Wetmore <co...@gmail.com>.
As far as I can tell, the github documentation pages are in HTML, not
markdown. To add MD pages I would need to have push permission. I can
create new pages within the github editor in HTML and create a pull request
for those. At the moment I am just testing out what I can do and what the
result looks like.
On Mon, Jan 15, 2018 at 8:16 PM, Andrew Wetmore <co...@gmail.com> wrote:
> How do we create navigation that shows up on each page of the
> documentation, as we have in the FlexJS part of the Flex wiki [1] or on
> Olaf's wiki [2], or in some other way? People will need to be able to
> browse without backing up to the top page of the help project over and over
> again.
>
> Thanks!
>
> a
>
> [1] https://cwiki.apache.org/confluence/pages/viewpage.
> action?pageId=34013930
>
> [2] https://github.com/olafkrueger/flexjs-docs/wiki
>
> On Mon, Jan 15, 2018 at 3:14 PM, Carlos Rovira <ca...@apache.org>
> wrote:
>
>> Hi I'm looking how to add a basic theme to royale-docs. But I'm not sure
>> our repo "royale-docs" is a Github pages repo.
>>
>> I'm trying this [1]
>>
>> And says
>>
>> Add the following to your site's _config.yml:
>>
>> But there's no such file, so my main question is, is royale-docs a Github
>> pages repo so I can customize it with a Github Pages Theme?
>> (if this could be done, I'll customize it to get the royale website basic
>> look and feel
>>
>> Hope someone could help me on this, so I could setup all in order to let
>> Andrew work more easily
>>
>> Thanks
>>
>>
>> [1] https://github.com/pages-themes/cayman
>>
>> 2018-01-14 23:08 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>>
>> > Hi,
>> >
>> > I think is a good idea to make some branding here. It should be very
>> easy.
>> > We should check [1].
>> > An example of this is [2]. So, I could see how a GitHub theme is done
>> and
>> > prepare one with some graphics, fonts and CSS from our website
>> > But I think this could be done in parallel to the migration and maybe as
>> > the theme is ready some changes must be done in the set of migrated
>> pages
>> > So for me the right place to do this work is [3] and publish in [4]
>> >
>> > [1] https://pages.github.com/themes/
>> > [2] https://pages-themes.github.io/merlot/
>> > [3] https://github.com/apache/royale-docs
>> > [4] https://apache.github.io/royale-docs/
>> >
>> >
>> > 2018-01-14 22:07 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
>> >
>> >> We have separate repository here [1]. Whatever you push there it will
>> be
>> >> automatically deployed here [2].
>> >> In what format it should be - well I always thought that it can be
>> bunch
>> >> of
>> >> github pages - Which we later display it somehow.
>> >>
>> >> If you look into some of the page in Olaf's starting point repository
>> [3]
>> >> -
>> >> You can change each of that page as an file for example
>> "Hello-world.md"
>> >> with exactly the same markers as it is on the wiki.
>> >>
>> >> In whatever direction you will go it will be good I think so, we can
>> later
>> >> change all of that to most suitable way.
>> >>
>> >> [1] https://github.com/apache/royale-docs
>> >> [2] https://apache.github.io/royale-docs/
>> >> [3] https://github.com/olafkrueger/flexjs-docs/wiki/Hello-world
>> >>
>> >> Thanks, Piotr
>> >>
>> >> 2018-01-14 21:54 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
>> >>
>> >> > Yes, that's an excellent beginning and structure.
>> >> >
>> >> > Royale will need a branded knowledge base. Will that be integrated in
>> >> the
>> >> > website, or a wiki hosted on github or somewhere else?
>> >> >
>> >> > a
>> >> >
>> >> > On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <
>> >> piotrzarzycki21@gmail.com
>> >> > >
>> >> > wrote:
>> >> >
>> >> > > Hi,
>> >> > >
>> >> > > We have started that effort here [1]. That was quite good starting
>> >> point.
>> >> > >
>> >> > > [1] https://github.com/olafkrueger/flexjs-docs/wiki
>> >> > >
>> >> > > Thanks, Piotr
>> >> > >
>> >> > > 2018-01-14 20:42 GMT+01:00 Carlos Rovira <carlosrovira@apache.org
>> >:
>> >> > >
>> >> > > > Changing subject
>> >> > > >
>> >> > > > About Github documentation, I think we should start migrating
>> what
>> >> we
>> >> > > have
>> >> > > > already at Apache Wiki in FlexJS.
>> >> > > >
>> >> > > > For Example this:
>> >> > > > https://cwiki.apache.org/confluence/display/FLEX/
>> >> > FlexJS+Basic+components
>> >> > > >
>> >> > > > Would be a great start
>> >> > > >
>> >> > > > About the documentation tag, I see you already introduced a bug
>> >> report,
>> >> > > > Maybe others want to comment as well regarding this issue
>> >> > > >
>> >> > > > thanks!
>> >> > > >
>> >> > > >
>> >> > > >
>> >> > > > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <cottage14@gmail.com
>> >:
>> >> > > > >>
>> >> > > > >>
>> >> > > > >> I am thinking about where to record and track tasks for future
>> >> > > > >> documentation. I see that our project in GitHub has a
>> >> > "documentation"
>> >> > > > tag
>> >> > > > >> with no active bug reports. Is that where I should enter, not
>> >> just
>> >> > > > >> documentation bug issues, but to-do stuff like "create a blog
>> >> entry
>> >> > on
>> >> > > > >> TOPIC X"? Or is there some other system for tracking stuff
>> like
>> >> > that?
>> >> > > > >>
>> >> > > > >> --
>> >> > > > Carlos Rovira
>> >> > > > http://about.me/carlosrovira
>> >> > > >
>> >> > >
>> >> > >
>> >> > >
>> >> > > --
>> >> > >
>> >> > > Piotr Zarzycki
>> >> > >
>> >> > > Patreon: *https://www.patreon.com/piotrzarzycki
>> >> > > <https://www.patreon.com/piotrzarzycki>*
>> >> > >
>> >> >
>> >> >
>> >> >
>> >> > --
>> >> > Andrew Wetmore
>> >> >
>> >> > http://cottage14.blogspot.com/
>> >> >
>> >>
>> >>
>> >>
>> >> --
>> >>
>> >> Piotr Zarzycki
>> >>
>> >> Patreon: *https://www.patreon.com/piotrzarzycki
>> >> <https://www.patreon.com/piotrzarzycki>*
>> >>
>> >
>> >
>> >
>> > --
>> > Carlos Rovira
>> > http://about.me/carlosrovira
>> >
>> >
>>
>>
>> --
>> Carlos Rovira
>> http://about.me/carlosrovira
>>
>
>
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>
>
>
>
>
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Andrew Wetmore <co...@gmail.com>.
How do we create navigation that shows up on each page of the
documentation, as we have in the FlexJS part of the Flex wiki [1] or on
Olaf's wiki [2], or in some other way? People will need to be able to
browse without backing up to the top page of the help project over and over
again.
Thanks!
a
[1]
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=34013930
[2] https://github.com/olafkrueger/flexjs-docs/wiki
On Mon, Jan 15, 2018 at 3:14 PM, Carlos Rovira <ca...@apache.org>
wrote:
> Hi I'm looking how to add a basic theme to royale-docs. But I'm not sure
> our repo "royale-docs" is a Github pages repo.
>
> I'm trying this [1]
>
> And says
>
> Add the following to your site's _config.yml:
>
> But there's no such file, so my main question is, is royale-docs a Github
> pages repo so I can customize it with a Github Pages Theme?
> (if this could be done, I'll customize it to get the royale website basic
> look and feel
>
> Hope someone could help me on this, so I could setup all in order to let
> Andrew work more easily
>
> Thanks
>
>
> [1] https://github.com/pages-themes/cayman
>
> 2018-01-14 23:08 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>
> > Hi,
> >
> > I think is a good idea to make some branding here. It should be very
> easy.
> > We should check [1].
> > An example of this is [2]. So, I could see how a GitHub theme is done and
> > prepare one with some graphics, fonts and CSS from our website
> > But I think this could be done in parallel to the migration and maybe as
> > the theme is ready some changes must be done in the set of migrated pages
> > So for me the right place to do this work is [3] and publish in [4]
> >
> > [1] https://pages.github.com/themes/
> > [2] https://pages-themes.github.io/merlot/
> > [3] https://github.com/apache/royale-docs
> > [4] https://apache.github.io/royale-docs/
> >
> >
> > 2018-01-14 22:07 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
> >
> >> We have separate repository here [1]. Whatever you push there it will be
> >> automatically deployed here [2].
> >> In what format it should be - well I always thought that it can be bunch
> >> of
> >> github pages - Which we later display it somehow.
> >>
> >> If you look into some of the page in Olaf's starting point repository
> [3]
> >> -
> >> You can change each of that page as an file for example "Hello-world.md"
> >> with exactly the same markers as it is on the wiki.
> >>
> >> In whatever direction you will go it will be good I think so, we can
> later
> >> change all of that to most suitable way.
> >>
> >> [1] https://github.com/apache/royale-docs
> >> [2] https://apache.github.io/royale-docs/
> >> [3] https://github.com/olafkrueger/flexjs-docs/wiki/Hello-world
> >>
> >> Thanks, Piotr
> >>
> >> 2018-01-14 21:54 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> >>
> >> > Yes, that's an excellent beginning and structure.
> >> >
> >> > Royale will need a branded knowledge base. Will that be integrated in
> >> the
> >> > website, or a wiki hosted on github or somewhere else?
> >> >
> >> > a
> >> >
> >> > On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <
> >> piotrzarzycki21@gmail.com
> >> > >
> >> > wrote:
> >> >
> >> > > Hi,
> >> > >
> >> > > We have started that effort here [1]. That was quite good starting
> >> point.
> >> > >
> >> > > [1] https://github.com/olafkrueger/flexjs-docs/wiki
> >> > >
> >> > > Thanks, Piotr
> >> > >
> >> > > 2018-01-14 20:42 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> >> > >
> >> > > > Changing subject
> >> > > >
> >> > > > About Github documentation, I think we should start migrating what
> >> we
> >> > > have
> >> > > > already at Apache Wiki in FlexJS.
> >> > > >
> >> > > > For Example this:
> >> > > > https://cwiki.apache.org/confluence/display/FLEX/
> >> > FlexJS+Basic+components
> >> > > >
> >> > > > Would be a great start
> >> > > >
> >> > > > About the documentation tag, I see you already introduced a bug
> >> report,
> >> > > > Maybe others want to comment as well regarding this issue
> >> > > >
> >> > > > thanks!
> >> > > >
> >> > > >
> >> > > >
> >> > > > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <cottage14@gmail.com
> >:
> >> > > > >>
> >> > > > >>
> >> > > > >> I am thinking about where to record and track tasks for future
> >> > > > >> documentation. I see that our project in GitHub has a
> >> > "documentation"
> >> > > > tag
> >> > > > >> with no active bug reports. Is that where I should enter, not
> >> just
> >> > > > >> documentation bug issues, but to-do stuff like "create a blog
> >> entry
> >> > on
> >> > > > >> TOPIC X"? Or is there some other system for tracking stuff like
> >> > that?
> >> > > > >>
> >> > > > >> --
> >> > > > Carlos Rovira
> >> > > > http://about.me/carlosrovira
> >> > > >
> >> > >
> >> > >
> >> > >
> >> > > --
> >> > >
> >> > > Piotr Zarzycki
> >> > >
> >> > > Patreon: *https://www.patreon.com/piotrzarzycki
> >> > > <https://www.patreon.com/piotrzarzycki>*
> >> > >
> >> >
> >> >
> >> >
> >> > --
> >> > Andrew Wetmore
> >> >
> >> > http://cottage14.blogspot.com/
> >> >
> >>
> >>
> >>
> >> --
> >>
> >> Piotr Zarzycki
> >>
> >> Patreon: *https://www.patreon.com/piotrzarzycki
> >> <https://www.patreon.com/piotrzarzycki>*
> >>
> >
> >
> >
> > --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
> >
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Carlos Rovira <ca...@apache.org>.
Hi I'm looking how to add a basic theme to royale-docs. But I'm not sure
our repo "royale-docs" is a Github pages repo.
I'm trying this [1]
And says
Add the following to your site's _config.yml:
But there's no such file, so my main question is, is royale-docs a Github
pages repo so I can customize it with a Github Pages Theme?
(if this could be done, I'll customize it to get the royale website basic
look and feel
Hope someone could help me on this, so I could setup all in order to let
Andrew work more easily
Thanks
[1] https://github.com/pages-themes/cayman
2018-01-14 23:08 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> Hi,
>
> I think is a good idea to make some branding here. It should be very easy.
> We should check [1].
> An example of this is [2]. So, I could see how a GitHub theme is done and
> prepare one with some graphics, fonts and CSS from our website
> But I think this could be done in parallel to the migration and maybe as
> the theme is ready some changes must be done in the set of migrated pages
> So for me the right place to do this work is [3] and publish in [4]
>
> [1] https://pages.github.com/themes/
> [2] https://pages-themes.github.io/merlot/
> [3] https://github.com/apache/royale-docs
> [4] https://apache.github.io/royale-docs/
>
>
> 2018-01-14 22:07 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
>
>> We have separate repository here [1]. Whatever you push there it will be
>> automatically deployed here [2].
>> In what format it should be - well I always thought that it can be bunch
>> of
>> github pages - Which we later display it somehow.
>>
>> If you look into some of the page in Olaf's starting point repository [3]
>> -
>> You can change each of that page as an file for example "Hello-world.md"
>> with exactly the same markers as it is on the wiki.
>>
>> In whatever direction you will go it will be good I think so, we can later
>> change all of that to most suitable way.
>>
>> [1] https://github.com/apache/royale-docs
>> [2] https://apache.github.io/royale-docs/
>> [3] https://github.com/olafkrueger/flexjs-docs/wiki/Hello-world
>>
>> Thanks, Piotr
>>
>> 2018-01-14 21:54 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
>>
>> > Yes, that's an excellent beginning and structure.
>> >
>> > Royale will need a branded knowledge base. Will that be integrated in
>> the
>> > website, or a wiki hosted on github or somewhere else?
>> >
>> > a
>> >
>> > On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <
>> piotrzarzycki21@gmail.com
>> > >
>> > wrote:
>> >
>> > > Hi,
>> > >
>> > > We have started that effort here [1]. That was quite good starting
>> point.
>> > >
>> > > [1] https://github.com/olafkrueger/flexjs-docs/wiki
>> > >
>> > > Thanks, Piotr
>> > >
>> > > 2018-01-14 20:42 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>> > >
>> > > > Changing subject
>> > > >
>> > > > About Github documentation, I think we should start migrating what
>> we
>> > > have
>> > > > already at Apache Wiki in FlexJS.
>> > > >
>> > > > For Example this:
>> > > > https://cwiki.apache.org/confluence/display/FLEX/
>> > FlexJS+Basic+components
>> > > >
>> > > > Would be a great start
>> > > >
>> > > > About the documentation tag, I see you already introduced a bug
>> report,
>> > > > Maybe others want to comment as well regarding this issue
>> > > >
>> > > > thanks!
>> > > >
>> > > >
>> > > >
>> > > > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
>> > > > >>
>> > > > >>
>> > > > >> I am thinking about where to record and track tasks for future
>> > > > >> documentation. I see that our project in GitHub has a
>> > "documentation"
>> > > > tag
>> > > > >> with no active bug reports. Is that where I should enter, not
>> just
>> > > > >> documentation bug issues, but to-do stuff like "create a blog
>> entry
>> > on
>> > > > >> TOPIC X"? Or is there some other system for tracking stuff like
>> > that?
>> > > > >>
>> > > > >> --
>> > > > Carlos Rovira
>> > > > http://about.me/carlosrovira
>> > > >
>> > >
>> > >
>> > >
>> > > --
>> > >
>> > > Piotr Zarzycki
>> > >
>> > > Patreon: *https://www.patreon.com/piotrzarzycki
>> > > <https://www.patreon.com/piotrzarzycki>*
>> > >
>> >
>> >
>> >
>> > --
>> > Andrew Wetmore
>> >
>> > http://cottage14.blogspot.com/
>> >
>>
>>
>>
>> --
>>
>> Piotr Zarzycki
>>
>> Patreon: *https://www.patreon.com/piotrzarzycki
>> <https://www.patreon.com/piotrzarzycki>*
>>
>
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Carlos Rovira <ca...@apache.org>.
Hi,
I think is a good idea to make some branding here. It should be very easy.
We should check [1].
An example of this is [2]. So, I could see how a GitHub theme is done and
prepare one with some graphics, fonts and CSS from our website
But I think this could be done in parallel to the migration and maybe as
the theme is ready some changes must be done in the set of migrated pages
So for me the right place to do this work is [3] and publish in [4]
[1] https://pages.github.com/themes/
[2] https://pages-themes.github.io/merlot/
[3] https://github.com/apache/royale-docs
[4] https://apache.github.io/royale-docs/
2018-01-14 22:07 GMT+01:00 Piotr Zarzycki <pi...@gmail.com>:
> We have separate repository here [1]. Whatever you push there it will be
> automatically deployed here [2].
> In what format it should be - well I always thought that it can be bunch of
> github pages - Which we later display it somehow.
>
> If you look into some of the page in Olaf's starting point repository [3] -
> You can change each of that page as an file for example "Hello-world.md"
> with exactly the same markers as it is on the wiki.
>
> In whatever direction you will go it will be good I think so, we can later
> change all of that to most suitable way.
>
> [1] https://github.com/apache/royale-docs
> [2] https://apache.github.io/royale-docs/
> [3] https://github.com/olafkrueger/flexjs-docs/wiki/Hello-world
>
> Thanks, Piotr
>
> 2018-01-14 21:54 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
>
> > Yes, that's an excellent beginning and structure.
> >
> > Royale will need a branded knowledge base. Will that be integrated in the
> > website, or a wiki hosted on github or somewhere else?
> >
> > a
> >
> > On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <
> piotrzarzycki21@gmail.com
> > >
> > wrote:
> >
> > > Hi,
> > >
> > > We have started that effort here [1]. That was quite good starting
> point.
> > >
> > > [1] https://github.com/olafkrueger/flexjs-docs/wiki
> > >
> > > Thanks, Piotr
> > >
> > > 2018-01-14 20:42 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> > >
> > > > Changing subject
> > > >
> > > > About Github documentation, I think we should start migrating what we
> > > have
> > > > already at Apache Wiki in FlexJS.
> > > >
> > > > For Example this:
> > > > https://cwiki.apache.org/confluence/display/FLEX/
> > FlexJS+Basic+components
> > > >
> > > > Would be a great start
> > > >
> > > > About the documentation tag, I see you already introduced a bug
> report,
> > > > Maybe others want to comment as well regarding this issue
> > > >
> > > > thanks!
> > > >
> > > >
> > > >
> > > > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> > > > >>
> > > > >>
> > > > >> I am thinking about where to record and track tasks for future
> > > > >> documentation. I see that our project in GitHub has a
> > "documentation"
> > > > tag
> > > > >> with no active bug reports. Is that where I should enter, not just
> > > > >> documentation bug issues, but to-do stuff like "create a blog
> entry
> > on
> > > > >> TOPIC X"? Or is there some other system for tracking stuff like
> > that?
> > > > >>
> > > > >> --
> > > > Carlos Rovira
> > > > http://about.me/carlosrovira
> > > >
> > >
> > >
> > >
> > > --
> > >
> > > Piotr Zarzycki
> > >
> > > Patreon: *https://www.patreon.com/piotrzarzycki
> > > <https://www.patreon.com/piotrzarzycki>*
> > >
> >
> >
> >
> > --
> > Andrew Wetmore
> >
> > http://cottage14.blogspot.com/
> >
>
>
>
> --
>
> Piotr Zarzycki
>
> Patreon: *https://www.patreon.com/piotrzarzycki
> <https://www.patreon.com/piotrzarzycki>*
>
--
Carlos Rovira
http://about.me/carlosrovira
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Piotr Zarzycki <pi...@gmail.com>.
We have separate repository here [1]. Whatever you push there it will be
automatically deployed here [2].
In what format it should be - well I always thought that it can be bunch of
github pages - Which we later display it somehow.
If you look into some of the page in Olaf's starting point repository [3] -
You can change each of that page as an file for example "Hello-world.md"
with exactly the same markers as it is on the wiki.
In whatever direction you will go it will be good I think so, we can later
change all of that to most suitable way.
[1] https://github.com/apache/royale-docs
[2] https://apache.github.io/royale-docs/
[3] https://github.com/olafkrueger/flexjs-docs/wiki/Hello-world
Thanks, Piotr
2018-01-14 21:54 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> Yes, that's an excellent beginning and structure.
>
> Royale will need a branded knowledge base. Will that be integrated in the
> website, or a wiki hosted on github or somewhere else?
>
> a
>
> On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <piotrzarzycki21@gmail.com
> >
> wrote:
>
> > Hi,
> >
> > We have started that effort here [1]. That was quite good starting point.
> >
> > [1] https://github.com/olafkrueger/flexjs-docs/wiki
> >
> > Thanks, Piotr
> >
> > 2018-01-14 20:42 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> >
> > > Changing subject
> > >
> > > About Github documentation, I think we should start migrating what we
> > have
> > > already at Apache Wiki in FlexJS.
> > >
> > > For Example this:
> > > https://cwiki.apache.org/confluence/display/FLEX/
> FlexJS+Basic+components
> > >
> > > Would be a great start
> > >
> > > About the documentation tag, I see you already introduced a bug report,
> > > Maybe others want to comment as well regarding this issue
> > >
> > > thanks!
> > >
> > >
> > >
> > > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> > > >>
> > > >>
> > > >> I am thinking about where to record and track tasks for future
> > > >> documentation. I see that our project in GitHub has a
> "documentation"
> > > tag
> > > >> with no active bug reports. Is that where I should enter, not just
> > > >> documentation bug issues, but to-do stuff like "create a blog entry
> on
> > > >> TOPIC X"? Or is there some other system for tracking stuff like
> that?
> > > >>
> > > >> --
> > > Carlos Rovira
> > > http://about.me/carlosrovira
> > >
> >
> >
> >
> > --
> >
> > Piotr Zarzycki
> >
> > Patreon: *https://www.patreon.com/piotrzarzycki
> > <https://www.patreon.com/piotrzarzycki>*
> >
>
>
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>
--
Piotr Zarzycki
Patreon: *https://www.patreon.com/piotrzarzycki
<https://www.patreon.com/piotrzarzycki>*
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Olaf Krueger <ma...@olafkrueger.net>.
Andrew Wetmore wrote
> Royale will need a branded knowledge base. Will that be integrated in the
> website, or a wiki hosted on github or somewhere else?
I am not sure if there's already an idea or decision about it.
My opinion is, to move stuff from the FlexJS wiki to the GitHub
asjs/compiler repo wikis using Markdown
would be a good idea.
This way we could easily reuse the articles if we'll go with a static site
generator in order to provide the documentation.
Just my 2 cents,
Olaf
--
Sent from: http://apache-royale-development.20373.n8.nabble.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Andrew Wetmore <co...@gmail.com>.
Yes, that's an excellent beginning and structure.
Royale will need a branded knowledge base. Will that be integrated in the
website, or a wiki hosted on github or somewhere else?
a
On Sun, Jan 14, 2018 at 3:53 PM, Piotr Zarzycki <pi...@gmail.com>
wrote:
> Hi,
>
> We have started that effort here [1]. That was quite good starting point.
>
> [1] https://github.com/olafkrueger/flexjs-docs/wiki
>
> Thanks, Piotr
>
> 2018-01-14 20:42 GMT+01:00 Carlos Rovira <ca...@apache.org>:
>
> > Changing subject
> >
> > About Github documentation, I think we should start migrating what we
> have
> > already at Apache Wiki in FlexJS.
> >
> > For Example this:
> > https://cwiki.apache.org/confluence/display/FLEX/FlexJS+Basic+components
> >
> > Would be a great start
> >
> > About the documentation tag, I see you already introduced a bug report,
> > Maybe others want to comment as well regarding this issue
> >
> > thanks!
> >
> >
> >
> > > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> > >>
> > >>
> > >> I am thinking about where to record and track tasks for future
> > >> documentation. I see that our project in GitHub has a "documentation"
> > tag
> > >> with no active bug reports. Is that where I should enter, not just
> > >> documentation bug issues, but to-do stuff like "create a blog entry on
> > >> TOPIC X"? Or is there some other system for tracking stuff like that?
> > >>
> > >> --
> > Carlos Rovira
> > http://about.me/carlosrovira
> >
>
>
>
> --
>
> Piotr Zarzycki
>
> Patreon: *https://www.patreon.com/piotrzarzycki
> <https://www.patreon.com/piotrzarzycki>*
>
--
Andrew Wetmore
http://cottage14.blogspot.com/
Re: Github Documentation (Re: Apache Royale website is live!!)
Posted by Piotr Zarzycki <pi...@gmail.com>.
Hi,
We have started that effort here [1]. That was quite good starting point.
[1] https://github.com/olafkrueger/flexjs-docs/wiki
Thanks, Piotr
2018-01-14 20:42 GMT+01:00 Carlos Rovira <ca...@apache.org>:
> Changing subject
>
> About Github documentation, I think we should start migrating what we have
> already at Apache Wiki in FlexJS.
>
> For Example this:
> https://cwiki.apache.org/confluence/display/FLEX/FlexJS+Basic+components
>
> Would be a great start
>
> About the documentation tag, I see you already introduced a bug report,
> Maybe others want to comment as well regarding this issue
>
> thanks!
>
>
>
> > 2018-01-14 16:04 GMT+01:00 Andrew Wetmore <co...@gmail.com>:
> >>
> >>
> >> I am thinking about where to record and track tasks for future
> >> documentation. I see that our project in GitHub has a "documentation"
> tag
> >> with no active bug reports. Is that where I should enter, not just
> >> documentation bug issues, but to-do stuff like "create a blog entry on
> >> TOPIC X"? Or is there some other system for tracking stuff like that?
> >>
> >> --
> Carlos Rovira
> http://about.me/carlosrovira
>
--
Piotr Zarzycki
Patreon: *https://www.patreon.com/piotrzarzycki
<https://www.patreon.com/piotrzarzycki>*