RE: [oic] Specification Analysis Wiki Clean-Up Step 3 - Repair Planning

["Dennis E. Hamilton" <dennis.hamilton@acm.org>]

Fortunately, I did sleep on it and, refreshed, was able to find the simplest way to repair the few (50 or so) wiki links that were upgraded incorrectly as part of the migration to wiki version 1.6.

1. THE CHOSEN APPROACH

  1.1 The current wiki content of pages that have not yet been corrected will be checked into the SVN repository.  This puts the SVN repository for the Specification Analysis in synchronization with the current post-update wiki content.

  1.2 If there were any other changes made to pages that had not yet been synchronized to the SVN repository (and I suspect there will have been none), I will make note of that during the 1.1 process and be sure to manually review the resulting checked-in page for additional work that may be required.

  1.3 In a working copy, the checked-in pages will be manually reviewed using a programming editor.  A search-and-replace will be done to manually repair those updated links that begin "[[self:".  These must be done manually because the correct substitution for "self:" can be different from page-to-page and even in different places on the same page.

  1.4 The pages modified in this process will be reviewed on the wiki and saved as changes when they pass review.

  1.5 I must remember to add the risk of upgrades to the wiki software as another concern on the discussion page about the considerations that apply to using the OIC TC Wiki in this way.

2. ROADS NOT TAKEN

  2.1 I considered what it would take to basically simulate the upgraded process on the existing SVN data using a script developed for that purpose.  I decided against it as much more work than (1.1-1.2) above, and (1.3-1.4) would be no different.  There was also the risk of missing changes that the 1.6 upgrader made that I did not notice.

  2.2 Because there is a working solution, I did not have to consider any Plan B that involved something so drastic as forking the Specification Analysis to a private project or anything else self-defeating like that.   

3. NEXT STEPS

  3.1 For the record, it will be useful that no one else do any editing to the Specification Analysis content on the wiki or the SVN repository until the synchronization process (1, above) is completed.

  3.2 I will indicate when I have completed steps (1.1-1.2) and also report progress and completion on (1.3-1.4), although the SVN Commit messages will provide tangible indications of the effort.

 - Dennis

-----Original Message-----
From: Dennis E. Hamilton [mailto:dennis.hamilton@acm.org] 
http://lists.oasis-open.org/archives/oic/200908/msg00029.html
Sent: Wednesday, August 26, 2009 20:26
To: 'OIC TC List'
Cc: 'Mary McRae'
Subject: [oic] Specification Analysis Wiki Clean-Up Step 3 - Repair Planning

1. I have completed the damage assessment steps that I specified last night.

2. I was able to completely bring the templates that are used to author pages in a text editor up to a wiki 1.6-compatible level.  The nature of the changes as they apply to the use of the OIC Wiki has been captured.

3. I have found no breaking changes between 1.6 and the earlier version that can't be handled by mostly-mechanical transformation to the existing wikiText on the SVN repository.

4. The next step is to find the best approach for doing this.  I am examining two options and will explore that further tomorrow.  
   4.1 Either option results in synchronization of the SVN pages used for authoring with the wikiText that is held by the wiki.  
   4.2 Because the upgrader rewrote pages on the wiki, we are currently out of sync.  In addition, as already discussed, the updated pages also have some incorrect changes.  While correction of those is not hard, it does required manual intervention and review.

More after I've slept on it.

 - Dennis

[ ... ]