WikiMigrationInstructions

Wiki Migration Instructions

The Wiki for CGI::Application is being migrated to GitHub. These are some steps I have been following to help ensure that nothing is missed in the migration, and that dead links are not presented while migrating.

The term old page is used to indicate the page on the existing wiki. The term new page is used to indicate the page on the GitHub CGI::Application wiki

• Create the new page with a single line indicating that it is being moved. The format I have been using is:

    Note: page is being migrated from _old page location_.
  

• Add a note to the top of the old page indicating that the page is being updated. The format I have been using is:

    Note: page is being migrated to _new page location_ by _your user name_.
  

• Copy the markup from the old page to the new page. Update the markup on the new page to one of the formats used by github. I have been using Markdown. Use the preview option on the new page to check your work before saving.

• Include a note on the bottom of the new page in this format:

    ----
    Originally transferred from http://cgi-app.org/index.cgi?_old page_
  

• Remove the original note on the new page (if it still exists).

• Update any backlinks on the old page (ensure that you have Backlinks turned on), and point them at the new page. I have been using the following format:

    [_new page name_ https://github.com/markstos/CGI--Application/wiki/_new page name_]
  

• Update the old page to include a link to the new page. I have been using the format:

    Note: page has been moved to https://github.com/markstos/CGI--Application/wiki/_new page_ by _your user name_
  

Bugs and shortcomings

• The theme for the existing wiki needs to be migrated to the new wiki.

• Links that point back to the old wiki from the new pages are not currently identified as needing to be updated. It would be nice to have a tool to validate that links back to the old wiki are nothing more than a historical comment.

• If a code block is within a list, you will either need to place an explicit code block indicator around it, or prefix it with 8 spaces instead of 4 spaces (4 for the code block, and 4 for the list item paragraph continuation. If you do not, various special characters ( <, for example ) may get mangled.

  A live test of this issue:

  With the 8 space prefix:

     print <<EOM if $foo eq 'bar';
     <% blah blah blah %>
     EOM
  

  With a 4 space prefix:

  print <<EOM if $foo eq 'bar'; <% blah blah blah %> EOM

  Hopefully this keeps someone else from needing to take time to research why and how to avoid.

Just my $0.02.

MidLifeXis