Background¶

There is currently a Wiki at https://bugs.ruby-lang.org/projects/ruby/wiki which contains documentation of processes, documentation of code, developers' meeting notes, and various other notes.

There are three main problems with the current Wiki setup:

• Out of date: Much of the documentation is out of date, or no longer relevant (for example: How to Release Ruby 1.9)
• Duplication: Some of this documentation exists both in the Wiki and in the docs in ruby/ruby (for example: DTrace Probes in the docs and DTrace Probes in the Wiki
• Editing docs is limited: Only Core contributors can edit the Wiki, and version control is more limited (for example: I couldn't edit any mistakes I found in the Wiki while preparing this issue).

Proposal¶

This proposal is to migrate any still relevant docs within the Wiki from the bugs.ruby-lang.org Wiki to a new GitHub Wiki. I have categorized all of the Wiki pages in this google sheet and given my analysis of which should be migrated. If there are any pages that should be migrated which aren't currently included, please indicate so in the comments and we will migrate them.

I also propose we migrate the old Developers' Meeting notes to the developer's meeting repository.

I spoke about this idea with @hsbt (Hiroshi SHIBATA) at Ruby Kaigi, and he and @naruse (Yui NARUSE) suggested that I write this proposal.

Implementation¶

0. Before I begin the migration, someone who has the appropriate permissions on GitHub will need to create the Wiki
1. I will migrate all pages listed in the Google sheet with "migrate?" checked to the new GitHub wiki
2. I will migrate all of the Developers' Meeting Notes to the developers' meeting repo
3. Someone who has the appropriate permissions will need to remove the Wiki from bugs.ruby-lang.org
4. I will update all GitHub wiki pages with "update?" checked in the Google Sheet to reflect the latest state