Misc #19679: Migrate Wiki from bugs.ruby-lang.org to ruby/ruby GitHub repository

• Status: Closed
• Assignee: jemmai (Jemma Issroff)

[jemmai (Jemma Issroff)]

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

[hsbt (Hiroshi SHIBATA)]

Thank you, Jemma.

Before I begin the migration, someone who has the appropriate permissions on GitHub will need to create the Wiki

I investigate wiki permission of GitHub. We can choose the following things:

1. Anyone can edit ruby/ruby wiki.
2. Only person who have write grant of ruby/ruby.

Now, we added write permission for only Ruby committers at ruby/ruby repo. So, I suggest to use option 1 at first for this migration. If we have an issue like SPAM, we will consider option 2 or something.

[jemmai (Jemma Issroff)]

hsbt (Hiroshi SHIBATA) wrote in #note-1:

So, I suggest to use option 1 at first for this migration

I agree, this makes sense and will allow me to execute the migration. Please let me know when we are ready to move forward with this option!

[hsbt (Hiroshi SHIBATA)]

I enabled GitHub wiki page: https://github.com/ruby/ruby/wiki

[k0kubun (Takashi Kokubun)]

@hsbt (Hiroshi SHIBATA) I think @jemmai (Jemma Issroff) should have Wiki edit permission on Redmine for updating/deleting migrated pages. Can we maybe create a group with "Triage team" permission on Ruby master and add Jemma to it?

[hsbt (Hiroshi SHIBATA)]

• Status changed from Open to Assigned
• Assignee set to jemmai (Jemma Issroff)

I added @jemmai (Jemma Issroff) to Triage team and added wiki CRUD grants to Triage team.

If you don't have wiki permission, please ask me again because configuration of Redmine is too complex.

[jemmai (Jemma Issroff)]

• File clipboard-202306060912-oxjwy.png clipboard-202306060912-oxjwy.png added

If you don't have wiki permission, please ask me again because configuration of Redmine is too complex.

Thanks @hsbt (Hiroshi SHIBATA), I think I still don't have edit permissions though.

[hsbt (Hiroshi SHIBATA)]

• File Screenshot 2023-06-08 at 14.32.44.png Screenshot 2023-06-08 at 14.32.44.png added

@jemmai (Jemma Issroff) I added you to Ruby project as triage team.

Can you confirm again?

[jemmai (Jemma Issroff)]

I now have permissions, thank you!

[jemmai (Jemma Issroff)]

Okay, I have now migrated all pages as listed on this sheet. The new wiki is live at https://github.com/ruby/ruby/wiki 🎉

Next week, I will delete all existing pages on the Redmine Wiki. I am leaving them up for a few more days in case anyone would like one more chance to indicate that a page which was not migrated should be migrated.

I have indicated on all migrated pages that they were migrated (for example https://bugs.ruby-lang.org/projects/ruby/wiki/GeneralMaintenancePolicy) so nothing gets out of sync.

[jemmai (Jemma Issroff)]

• Status changed from Assigned to Closed

[hsbt (Hiroshi SHIBATA)]

Thanks Jemma,

I disabled wiki feature of Redmine at last week.