Re: Migrating existing FlexJS documentation to Royale

Hi, Or possibly you could just link the markdown content to "src/site/markdown” (ln -s ../../../royale-docs markdown from /src/site is royale-asjs) [1] and do a “mvn site site:stage” to test locally and a "mvn site-deploy” to deploy if you have permission. I believe Chris set this all of this

Re: Migrating existing FlexJS documentation to Royale

OK, got jekyll working locally. I followed these instructions: https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver /standalone/oss/install_language_runtime.html One of the steps was to install bundler. That might be why you got the .bundle error. You will also need to

Re: Migrating existing FlexJS documentation to Royale

Thanks Alex, I can see it working online :) I'm trying to test it localy but don't know how to do it. In order to make the html/css looks good, I need to work localy, please let me know how yo do it I installed already ruby, jekyll, etc... and tried to run "bundle exec jekyll serve" but we don't

Re: Migrating existing FlexJS documentation to Royale

OK, I got the CSS to load. You can hit this link: https://apache.github.io/royale-docs/test/test.html I'm going to look into automatic TOC generation next. IMO, we should decide what kind of header/footer we want not only for the docs on this site, but for ASDoc and Olaf's TryItNow as well and

Re: Migrating existing FlexJS documentation to Royale

I'm out of time for today, but I tested templates and jekyll and started to get something to work. https://apache.github.io/royale-docs/test/test.html You can see the test/test.md and _layouts/docpage.html in the royals-docs repo. The CSS file didn't load for some reason. Feel free to figure

Re: Migrating existing FlexJS documentation to Royale

Here is how Electron does it with Github pages: Documentation result page: https://electronjs.org/docs/api/accelerator Source code: https://github.com/electron/electron/blob/master/docs/api/accelerator.md Some documentation on how this works:

Re: Migrating existing FlexJS documentation to Royale

This is for doc, not code so I'm not sure the issue I raised matters. That said, I've been reading this [1] and it seems like we should be able to set up a few templates sort of like we did flex.a.o and not worry so much about customizing a third-party theme. [1] https://jekyllrb.com/docs On

Re: Migrating existing FlexJS documentation to Royale

Carlos, I like your findings jeckyll theme doc. It looks like we may have again similar issue with license as we have in MDLExample. Can someone raise jira for both cases? Alex raises question on legal couple of days ago. No responses. Let's not wait block us with it - push things forward. Jira

Re: Migrating existing FlexJS documentation to Royale

Hi, > I think this looks very good and seems to be responsive > > [1]http://mistic100.github.io/jekyll-bootstrap-doc > [2] https://github.com/allejo/jekyll-docs-theme From a quick look this contains CSS code licensed under CC-BY-3.0 (looks like it comes from bootstrap docs). That may or may

Re: Migrating existing FlexJS documentation to Royale

Hi, One option you might want to look into is using this [1] and using maven to build the site and auto publish when changes are made in GitHub via jenkins. We’re doing this on the PLC4X incubating project [2] (so it’s still a work in progress), it's not using markdown but is using asiidoc

Re: Migrating existing FlexJS documentation to Royale

Hi, > please check this link for licenses [1] and let me know if is ok for us to > use this theme as base I would double check carefully from a quick look it contains a number of differently licensed components including ALv2, MIT and BSD licensed files.(Which should all be all fine) There

Re: Migrating existing FlexJS documentation to Royale

Yes, that looks fine. On Thu, Jan 18, 2018 at 8:30 PM, Carlos Rovira wrote: > Hi This is another one [1] based in MIT. Check girhub repo [2] > > I think this looks very good and seems to be responsive > > > [1]http://mistic100.github.io/jekyll-bootstrap-doc > [2]

Re: Migrating existing FlexJS documentation to Royale

Hi This is another one [1] based in MIT. Check girhub repo [2] I think this looks very good and seems to be responsive [1]http://mistic100.github.io/jekyll-bootstrap-doc [2] https://github.com/allejo/jekyll-docs-theme 2018-01-19 1:22 GMT+01:00 Carlos Rovira : > Hi

Re: Migrating existing FlexJS documentation to Royale

Hi Dave, FWIS there, this is the website, with info about how to develop, mailing list, support. For me this match our current website right?, but I think, not the documentation of the project. do you have a link to the documentation to see how is done? 2018-01-19 0:57 GMT+01:00 Dave Fisher

Re: Migrating existing FlexJS documentation to Royale

Hi - I’m sure you guys will figure it out. Here is how Apache OpenOffice did it about 6 years ago using the Apache CMS. (Now discouraged, but possible) Markdown is good and you can do something complex. Take a look. https://openoffice.apache.org/website-local.html

Re: Migrating existing FlexJS documentation to Royale

@Alex, please check this link for licenses [1] and let me know if is ok for us to use this theme as base The results can be seen in [2] I see others as well that are MIT only and very few that are ALv2. I assume that both are ok for us. My intention is configure royale-docs to use that theme

Re: Migrating existing FlexJS documentation to Royale

Hi Alex, 2018-01-19 0:44 GMT+01:00 Alex Harui : > OK, I'm sure you will figure it out. But if we all agree on MarkDown, I > think we can start writing content in MarkDown and committing it? Then > later, the theme will just magically appear or maybe we have to add a

Re: Migrating existing FlexJS documentation to Royale

I am fine with using MarkDown if someone can assure me that there will, eventually, be a way to display a navigable index that will help the reader jump around through the pages. On Thu, Jan 18, 2018 at 7:44 PM, Alex Harui wrote: > OK, I'm sure you will figure it out.

Re: Migrating existing FlexJS documentation to Royale

Hi, Alex: As you were writing your note, I was posting this on https://github.com/apache/royale-asjs/issues/110 I am thinking about a structure for our documentation that helps people who are new to Royale move into using the framework with satisfaction, and that helps people who are already

Re: Migrating existing FlexJS documentation to Royale

OK, I'm sure you will figure it out. But if we all agree on MarkDown, I think we can start writing content in MarkDown and committing it? Then later, the theme will just magically appear or maybe we have to add a tag or two to each page? -Alex On 1/18/18, 3:36 PM, "carlos.rov...@gmail.com on

Re: Migrating existing FlexJS documentation to Royale

Hi Alex, I'm right now fighting with Jekyll and themes. I have working a minimal example localy and trying to see how to: * Jekyll themes work in order to configure a basic one with basic website royale branding (fonts, colors and sizes) * How this means for ease of development, I'm still trying

Re: Migrating existing FlexJS documentation to Royale

Hi Andrew, I've been thinking that we don't want to directly copy the FlexJS pages to GH Pages. I think it needs better organization. I think the question for you is how much time you have and what you would like to do with your time. I'm hoping to spend some time on doc once RC2 is posted. I

Re: Migrating existing FlexJS documentation to Royale

Hi Andrew, I think the initial approach is ok. We need to work all together since we need: * Technical info that is accurate to help people get started or solve a problem with some part of Royale * Be as clear as possible in terms of organization (how to organize the content), grammatical

Migrating existing FlexJS documentation to Royale

Hi, all: I want to start upgrading the very useful documentation we have that currently refers to FlexJS [1]. At the very least every document needs edits to make sure it refers to Royale. However, there are some other considerations: - Is there material that needs to be rewritten because