User:Aeric/Rename the Wiki

From LongJump Support Wiki
< User:Aeric
Revision as of 23:41, 9 January 2014 by imported>Aeric
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This action becomes necessary when a release that was due before the end of the year is postponed to the next year. (As for example, lj72, which became lj80 when the 7th year release was delayed until the beginning of the 8th year.)

To rename the wiki

  1. Rename the directory from /lj{old} to /lj{new}
  2. In the Apache config file, etc/httpd/conf.d/mediawiki.conf:
    • Alias /lj{old} /usr/share/mediawiki/lj{old}
        => Alias /lj{new} /usr/share/mediawiki/lj{new}
    • <Directory /usr/share/mediawiki/lj{old}>
        => <Directory /usr/share/mediawiki/lj{new}>
  3. Replace the images in skins/lj7monobook:
    • _Logo.png - Logo image w/version# at top left
      • Use Adobe Illustrator to edit the source file in the SVN repo: Relationals/techpubs/images/logos/LJ_Logo.ai
      • Export to PNG
    • __.ico - favicon file (version# image for links)
      • This file cannot have an underscore in its name, or it won't work.
      • Freely available IcoFX is good for editing it.
      • 32x32,16-color (4-bit) icon-format file
      • Font: Stencil (not Stencil Standard), Normal (not bold)
      • Size: 34 px

OLD PROCESS

To rename the wiki

  1. Rename: /lj{old_working_version} --> /lj{new_working_version}
    Ex: /lj72 --> /lj80
  2. Modify: /{newWiki}/LocalSettings.php:
    Change $wgScriptPath to point to new working version
  3. Copy: /lj{production_version} --> /lj{old_working_version}
    Ex: Copy /lj71 --> lj72
    Reason: The production version directory is a redirection.
    It's only contents are index.php and a symlink to the download area.
    (See the content description below)
  4. Modify /lj{old_working_version}/index.php to redirect to /{newWiki}
    Ex: /lj80
  5. In skins/common/images, modify the version-numbers in the images:
    • _version_logo.gif - Logo image w/version# at top left
      TechSmith/SnagIt editor is good for this.
      • Use the eyedropper tool to set the foreground color.
      • Font: Stencil Standard, Bold
      • Size: 38 px
    • _.ico - favicon file (version# image for links)
      Note: This file cannot have an underscore in its name, or it won't work.
      Freely available IcoFX is good for this
      32x32,16-color (4-bit) icon-format file
      • Font: Stencil (not Stencil Standard), Normal (not bold)
      • Size: 34 px
  6. In /{newWiki} Wiki pages:
    • Rename these pages (use the redirects below to get to them, and choose "Move"):
      • Version ___ Platform
      • Version ___ Doc Notes
      • Version ___ ISV Release Notes
    • Then change the redirect pages to point to the new versions:

Contents of the {version} redirect-folder

The redirected folder is lj{curr_version} (e.g. /lj80).

It's contents never have to be changed, because they are always pointing to the current version of the documentation, at /wiki. This section simply documents how they were created, and what they do.

When a new version is released, renaming the folder is all that is necessary, so that /lj80 becomes /lj81 when 8.1 becomes current, etc.

Here's what it contains:

A. A symlink that goes to the /wiki download area
  • Redirects download-area accesses
  • Created in the login shell
cd /lj{curr_version}
ln -s ../wiki/download
B. index.php:
  • Redirects wiki-page accesses
<?php

if(($_SERVER['HTTP_HOST'])==('lj.platformatyourservice.com'))
{
  header( 'Location: http://lj.platformatyourservice.com/wiki' ) ;
}
else if(($_SERVER['HTTP_HOST'])==('isv.platformatyourservice.com'))
{
  header( 'Location: http://isv.platformatyourservice.com/wiki' ) ;
}

?>
Note
A copy of those files is in the public_html/ directory (the root directory of the server domains), so simply typing in the server name into the browser's address bar takes you to the right place.

Contents of /next redirect-folder

  • The /next folder is a copy of the redirect folder above, except that it points to the ".next" version.
  • It was created for the convenience of the wiki author:
  • It allows bookmarks to point to the "next" version of the wiki, so changes can be made in one place.
  • It may or may not be of any use to others.
  • When you rename the Wiki or Create a New Branch, you should modify the contents of /next, so it points to the right place.

{{Note|After releasing a new version, work will continue on the current (/wiki) version for a while. The creation of a branch may not happen for a while.)