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 <[email protected]> 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 <[email protected]> > 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 <[email protected]> > > 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 <[email protected]>: > >> > >> > 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 <[email protected] > >: > >> > > >> >> 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 <[email protected]>: > >> >> > >> >> > 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 < > >> >> [email protected] > >> >> > > > >> >> > 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 < > [email protected] > >> >: > >> >> > > > >> >> > > > 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 < > [email protected] > >> >: > >> >> > > > >> > >> >> > > > >> > >> >> > > > >> 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/ >
