Transition to GitHub Wiki & Issues

[rubychan]

Transition to GitHub Wiki & Issues

[korny]

I set you up (user "nathany"), there were problems in the past with mail not being sent. Sorry about that. Your account should be activated now, and you should be a member of the CodeRay project.

[nathany]

Thanks Murphy. I can login now. Is there a way I could view/edit the Wiki markup over there? I would like to move it over to the GitHub wiki powered by Gollum.

Trying to get everything in one place, and then it would be nice to expand upon the contributor guidelines for people like me who aren't sure what they are doing. :-)

[korny]

Sorry, the permissions were not set correctly. You should be able to edit the Wiki now, so you can copy the Textile source.

[nathany]

What do you think of pointing to http://rdoc.info/gems/coderay/frames for API documentation?

One less thing to maintain.

[nathany]

Do you prefer the Changelog(s) in the repo or in the Wiki? (Textile either way).

[nathany]

@korny I've noticed a number of links from the Wiki into the Redmine issue tracker, often containing useful information. A consideration before shutting down Redmine. There are also links to pages on the web site (JSON, etc.)

Another consideration is that this Wiki will use Pygments, so I assume we would want any examples of highlighted code to be on the web site or perhaps the rdocs.

Perhaps:

• README - getting started
• web site - getting started, examples, and extended usage information
• Wiki - testing/contributing, who's using CodeRay

Or perhaps the Wiki becomes less used after a website redesign?

[nathany]

The Wiki (Comparison With Pygments) still references http://odd-eyed-code.org/issues/122 which has not been moved over in one form or another.

[nathany]

@korny All the pages on the Redmine Wiki have been moved to GitHub, with some revisions and broken links fixed on the way.

I also moved over all open Issues, with few exceptions, as follows.

I'd rather these were filed under the coderay-site + documentation (if they need to be listed at all):

• Task 58: Redesign CodeRay website (tutorials, FAQ, more examples, tricks, comparisons, features explained)
• Task 236: Make a List of TokenKinds, their meaning, and typical use (like TextMate docs)
• Task 360: Add Fork me on GitHub badge
• Task 363: Blog about new features in 1.0 (diff, CLI, Direct Streaming)

It seems like these could be closed:

• Bug 137: JavaScript scanner is confused by nested XML literals (E4X is deprecated)
• Task 228: Investigate Dottoro's scanners
• Bug 380: The gemspec for CodeRay on rubygems.org is invalid (fixed in May and is part of RubyGems 1.8.3.)
• Bug 225: HTML Typography
• Feature 144: Conquer the World :-)

So you could turn off Redmine now, or at least stop linking to it from your site.

In GitHub I shifted some issues to 1.0.9 or Future, under the assumption that you might want to adjust the milestones further.

As I couldn't attach files to GitHub issues, I went ahead and add branches with the code, even though much of this code could be older and need revisions. I also put the test code into a repo: rubychan/coderay-scanner-tests#1.

Hope this helps,
Nathan.

[korny]

I'll definitely keep #144 open!