Temp Foswiki up / GitHub wiki construction

[Cervator]

I've put the old Foswiki content up on a home server of mine temporarily since it is taking a tad longer to get the stuff out of it than expected. Maybe we should even go through the effort of setting it up on the official server - this version cannot handle any substantial load, so please no Gronkhage

http://wiki.nanoware.org/Terasology/WebHome - old homepage

http://wiki.nanoware.org/Terasology/WebTopicList - index of all pages, several are not linked from anywhere else as I moved them in from another (old hidden) web

Note that all this stuff is pretty raw, a lot of it dates from the very early days shortly after I met begla - and of course most of it is outdated at this point

Immortius - your ES page is over here - but users won't work as I just crammed our pages into a personal wiki instance of mine, we'll need to move it elsewhere

Happy to answer any questions / supply updates to the old stuff, especially if somebody will volunteer to do write-ups somewhere else. Question is what this something else should be - not sure yet.

Edit: Did I mention this is on a weak machine at my house? Yeah.. it might go poof if a thundercloud sneezes at our house or more than a few users try to hit it at once

 

[AlbireoX]

Slow! Just use Github!

 

[Cervator]

Slow! Just use Github!

Sure, right after you paste every single old page on to there and adjust all the formatting / make links

x3ro might be willing to help with that, incidentally, yay

 

[x3ro]

Indeed! I started migrating stuff from the old Wiki to GitHub. I've set up a page to track the migration progress. It also contains some questions I have regarding the migration of specific pages. Feel free to join me in migrating stuff. If you do it would be awesome if you could coordinate your effort with me in IRC, so we don't end up migrating the same pages =)

 

[Cervator]

Thanks! I've put some feedback on the migration page and deleted all the page entries that are junk (wiki structure pages, user pages, etc). Also filled in FancyGit as I had already converted that one in a test GH wiki

 

[Cervator]

Just put the server back up, rebooted for some reason (prolly power blip). Really need to put that thing back on a UPS.

Properly migrated the Dev Setup page and tweaked Fancy Git as well (They have spaces now! Fancy!)

https://github.com/MovingBlocks/Terasology/wiki/Dev-Setup
https://github.com/MovingBlocks/Terasology/wiki/Fancy-Git

 

[AlbireoX]

Sure, right after you paste every single old page on to there and adjust all the formatting / make links

x3ro might be willing to help with that, incidentally, yay

IT should be simple. I'm sure there's a WikiCreole to Markdown converter somewhere in the world. If not that would be a fun project.

 

[x3ro]

IT should be simple. I'm sure there's a WikiCreole to Markdown converter somewhere in the world. If not that would be a fun project.

I didn't know what the FOSWiki Markup was called, and I didn't really find anything in the FOSWiki docs either. Now that I know what its called it will be a lot easier to search for such a converter. I also thought about writing one myself, but I currently lack the motivation to start another micro-project

 

[Cervator]

There really isn't enough to worry about any sort of converter, we're talking like 10-20 pages and most the syntax already matches

Main thing I'm doing is replacing = with ` (monospace) and changing the headers from ---+ to # (and ---++ to ##, etc) then also making actual corrections to the content as I fix it. Couple search & replaces will do most of it just fine, I'm just taking my time and actually improving what I migrate.

Foswiki syntax is called TML - Topic Markup Language.

 

[AlbireoX]

There really isn't enough to worry about any sort of converter, we're talking like 10-20 pages and most the syntax already matches

Main thing I'm doing is replacing = with ` (monospace) and changing the headers from ---+ to # (and ---++ to ##, etc) then also making actual corrections to the content as I fix it. Couple search & replaces will do most of it just fine, I'm just taking my time and actually improving what I migrate.

Foswiki syntax is called TML - Topic Markup Language.

I will go and convert it then. Will report back when it's up.

 

[x3ro]

For everyone who migrates stuff from the FOSwiki. Please make sure that the pages you migrate are actually linked on the "migration progress" page ( https://github.com/MovingBlocks/Terasology/wiki/Migrating-pages-to-the-GitHub-Wiki ). Otherwise someone else might accidentally try to migrate it again (e.g. me )

 

[Cervator]

For everyone who migrates stuff from the FOSwiki. Please make sure that the pages you migrate are actually linked on the "migration progress" page ( https://github.com/MovingBlocks/Terasology/wiki/Migrating-pages-to-the-GitHub-Wiki ). Otherwise someone else might accidentally try to migrate it again (e.g. me )

One thing that'll probably cause Fun here is that we don't really need CamelCase for pages on GitHub (but that's how Foswiki works). So I've occasionally spaced a page out (Dev Setup, Fancy Git). Tried to do that on the migrate page too, but am likely not being as attentive as I should be ...

 

[Cervator]

/me waves wand at thread title and location for more accuracy

I've found my way into working the GitHub wiki via Git (in IntelliJ), which is pretty dang spiffy. Figured out how I can scratch my automated documentation itch some while also differentiating between stable/unstable features:

1) Expand the nice approach of having console commands defined in the source tree in json files with some basic help - could do the same for key bindings and even tool items
2) On a develop/unstable build in Jenkins attach a HelpParser job that'll go check if any of the help files changed and if so update/regenerate a GitHub wiki page specific to that topic - via Git on the separate wiki repo
3) On a master/stable build in Jenkins attach a ReadmeUpdater job that'll grab the help pages in the wiki and use those to update README.markdown - in the develop branch, whose copy is what gets displayed on the GitHub front page

That way we essentially never need to work to keep any simple help text from going out of date on the official site locations. We define the README.markdown as canon for stable/master builds and the help pages in the wiki as canon for unstable/develop builds

Main thought that brought that up was thinking about updating README.markdown as it has gone a fair bit out of date, while also preparing different details for develop where miniME89 is changing the console with slash commands / chat system.

On a related note we could possibly come up with more human friendly change/release notes by pushing raw commits to a wiki page then apply some human friendly edits via wiki interface whenever time permits (no later than at stable builds). That could be used in a Launcher news box. On the other hand, RSS might be more appropriate, and already available in Jenkins, but it just gives you the raw commit info which really could use some polish first.

Finally as a reminder: we can apparently add sidebars, headers, and footers to the GitHub wiki via Git, which then supposedly show up and can be edited via the wiki interface.

 

[Cervator]

Updated a bunch more GitHub wiki pages especially fixing broken links. Also created a page on Markdown in IntelliJ and using Git to edit the wiki which continues to be very nifty. Started updating the readme to reflect master and develop separately, but that's not done yet, it is nearly 2 am, and I'm merging code