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
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.githu
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 :
> Carlos,
>
> What'
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
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 :
> Just created the ticket her
Just created the ticket here:
https://issues.apache.org/jira/browse/INFRA-15845
2018-01-16 13:03 GMT+01:00 Carlos Rovira :
> 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 sty
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 p
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
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
>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
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
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 s
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
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 -
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 lo
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
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 custom
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 a
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 reposit
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 rep
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
wrote:
> Hi,
>
> We have started that effort here [1]. That was q
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 :
> Changing subject
>
> About Github documentation, I think we should start migrating what we have
> already
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 introduc
23 matches
Mail list logo
