netlify – Publishing from Github to static Pages

[Thomas Elmiger]

Hi all

Today I found some stuff via Twitter that could be of interest for publishing TW stuff from Github directly.

Smashing Magazine published a betaversion of their new website and they are going very innovative ways using netlify and Hugo amongst many other things:

https://next.smashingmagazine.com/2017/03/a-little-surprise-is-waiting-for-you-here--meet-the-next-smashing-magazine/

To understand netlify and it's philosophy I found the video here helpful: https://www.netlifycms.org/docs/intro/

I could imagine using TW as a CMS instead of their react-based app but I have no idea how difficult it would be to adapt parts of their system to process tid files and wikitext instead of markdown … I found it very interesting nonetheless.

Have a nice weekend!
Thomas

=== Extract:

We are moving to a JAMstack: articles published directly to Netlify CDNs, with a custom shop based on an open-sourced headless E-Commerce GoCommerce and a job board that’s all just static HTML; content editing with Netlify’s new open-source, Git-Based CMS, real-time search powered by Algolia, full HTTP/2 support, and the whole website running as a progressive web app with a service worker in the background (thanks to the awesome Service Worker Toolbox library). Booo-yah!

How does it work? Quite simple, actually. Content is stored in Markdown files. HTML is pre-baked using the static site generator Hugo, combined with a modern asset pipeline built with Gulp and webpack, all based on the Victor Hugo boilerplate.

We’ve spiced it all up with a handful of fancy APIs, including ones by Stripe for payments, Algolia for search, Cloudinary for responsive images, and Netlify’s open-source APIs GoCommerce (a headless e-commerce API), GoTrue for authentication, and GoTell for our more than 150,000 comments.

[PMario]

Hi Thomas,

TW can do all that stuff out of the box. No additional tools needed.

-m

[Thomas Elmiger]

Hi Mario

I am not aware of automated publishing of https://github.com/jermolene/tiddlywiki5 for example.

What TW5 is lacking is a publishing process including Github. And with it endless versioning, rollback, diff, roles for authors and publishers, multi-user capabilities, commits with comments, …

I know that there are attempts to add some of these to TW5 – why not use existing external solutions? (As an option. Until TW5 can take over.)

Imagine a documentation wiki, lets call it “TW5 Cookbook”, where every TW5 user can contribute or improve recipes. Via Github. As soon as an update is confirmed (merged) by a member of a certain group (on Github) it is published to a website via a completely automated process.

I think such a concept could cover several topics discussed in many posts about the (lack of) central ducumentation.

Have a nice sunday!
Thomas

[Hans Wobbe]

On Sunday, March 19, 2017 at 5:45:39 AM UTC-4, Thomas Elmiger wrote:

...

Imagine a documentation wiki, lets call it “TW5 Cookbook”, where every TW5 user can contribute or improve recipes. Via Github. As soon as an update is confirmed (merged) by a member of a certain group (on Github) it is published to a website via a completely automated process.

I think such a concept could cover several topics discussed in many posts about the (lack of) central documentation.

...

 
I find this to be an attractive scenario that may be achievable with just a bit more effort at documenting a composite work-flow spanning the two environments.  I have found my way of doing things lately is gradually morphing to use TW in combination with other tools such as DebateGraph so that I get the benefits of both environments.  The one detail I find that needs a lot of attention when doing this is the need for an effective Names policy since I inevitably want to such "bipolar" objects to have the same Name in each context.  That becomes problematic sometimes when the two tools recognize different characters sets (e.g. DebateGraph does not recognize all UTF-8 characters).

[PMario]

On Sunday, March 19, 2017 at 10:45:39 AM UTC+1, Thomas Elmiger wrote:

I am not aware of automated publishing of https://github.com/jermolene/tiddlywiki5 for example.

... That doesn't mean that it's non existent ...
 

What TW5 is lacking is a publishing process including Github. And with it endless versioning, rollback, diff, roles for authors and publishers, multi-user capabilities, commits with comments, …

Right!

I did set up a proof of concept (POC) [1] last year for the first TW meetup.
It's a continuous delivery process using travis-ci.org [2]. ...

I did create an experimental landing page [4] for the "Multi Language Documentation" project. [5][6].. The landing page itself has a blog like structure. It should have some basic "teaser" texts and link to the real tw versions eg: [5][6].
The POC defines some Major Goals [7], which imo are essential for a newly created "Community Page" that is not TW.

The only real problem we have here is, the github pages DNS setup for tiddlywiki.com [8]   .... The repo structure would need to be changed, in a way that is controversial and therefore stalled since a year.

I know that there are attempts to add some of these to TW5 – why not use existing external solutions? (As an option. ...

Because we have a fully working prototype solution!

@Jeremy and "UnaMesa Associaton": Can the community use the domain tiddlywiki.org, which could be linked to a completely new github organisation.
Or do we need to create a new one. tiddlywiki.info seems to redirect to tiddlywiki.com atm.

... Until TW5 can take over.)

TLDR; As I wrote. Restructuring the current structure / process is a controversial topic between me and Jeremy. So we "agreed to disagree" atm ;)

--------

For this to happen, we need to convince Jeremy, that we need some project restructuring, where we have an "upstream" repository, which is the CI-CD build master and the Jeremolene repo is a contributor as everyone else. .. He can have the final say on everything "core related" ... but the community stuff, is totally in control of the community groups and the whole integration and delivery process is fully automated! ... including tiddlywiki.com

IMO the manual build process, that Jeremy uses at the moment [3] is very work intensive and only works for his local development setting.

Imagine a documentation wiki, lets call it “TW5 Cookbook”, where every TW5 user can contribute or improve recipes. Via Github. As soon as an update is confirmed (merged) by a member of a certain group (on Github) it is published to a website via a completely automated process.

Yea... see [1]. The workflow used at the moment is:  If something is pushed to "master", "gh-pages" will be updated.

It could be improved, like this:

 - If someone creates a PR pull request, a temporary page will be automatically created, for validation and testing
   - no tiddlyspot pollution with "throw away TWs" needed anymore.
   - The availability will be posted to eg: gitter chat [10], which has excellent github integration
   - Discussion can happen there [10] or directly within github-issues [11]. Depending on the users preferences.
 - If the PR is legitimated, it will be pushed, and automatically delivered.

I think such a concept could cover several topics discussed in many posts about the (lack of) central ducumentation.

You are right. ... But only for those, who are willing to join github.
My language- github repo looks like this [12] ... That's the repo I have to use to create my PRs against the upstream repo [1].
 

Have a nice sunday!
Thomas

Sure :)

have fun!
mario
PS: I'll try to record a little video, how this stuff can be used. It will show one full development cycle, from editing stuff to the published content. ... If I can keep it short enough.

[1] https://github.com/TiddlyWiki/languages
[2] https://travis-ci.org/TiddlyWiki/languages/
[3] https://github.com/Jermolene/build.jermolene.github.io
[4] http://classic.tiddlywiki.com/languages/static.html
[5] http://tiddlywiki.com/languages/de-DE/
[6] http://tiddlywiki.com/languages/fr-FR/
[7] https://github.com/TiddlyWiki/languages#major-goals
[8] https://github.com/TiddlyWiki
[9] https://en.wikipedia.org/wiki/Continuous_delivery
[10] https://gitter.im/TiddlyWiki/languages
[11] https://github.com/TiddlyWiki/languages/issues
[12] https://github.com/pmario/tiddlywiki-languages

[Hans Wobbe]

@Mario

Thanks for the links!  I really do need a refresher course :-)

Cheers,
Hans

[Douglas Counts]

Daniel Rodríguez Rivero already has a tool to do this on GitHub called Octowiki.  I haven't personally used his Octowiki tool to edit TWs on GitHub, but you can click the GitHub link I just provided to give it a look.

He also has a lot of TW stuff on his personal GitHub site too.

-Doug

[Danielo Rodríguez]

Hey! Douglas, you found it!

It's about to be released