Difference between revisions of "Workplan"

From Freephile Wiki
Jump to navigation Jump to search
(first draft)
(edits from Jeff)
Line 5: Line 5:
  
 
== Progress Report / Work Summary ==
 
== Progress Report / Work Summary ==
* Failed attempt to transfer DCS Wiki, as is, to QualityBox. Reason: complexity and way the current SSO and authentication code is woven into LocalSettings plus other extensions
+
* Failed attempt to transfer DCS Wiki, as is, to QualityBox. Reason: complexity and way the current SSO and authentication code is woven into LocalSettings (configuration) and other extensions (code).
* 100% coverage and review of the [[extension inventory]]; Can still reformat (consolidate); remove unused extensions; and get input from Aran or get more detailed on how to achieve priorities.
+
* 100% coverage and review of the [[extension inventory]]. Need to still reformat (consolidate); remove unused extensions; and get input from Aran or get more detail on how to achieve priorities.
  
 
== Evaluation of progress in achieving priority objectives ==
 
== Evaluation of progress in achieving priority objectives ==
Line 19: Line 19:
 
|-
 
|-
 
| 3-6 <ref>Already spoke with Mark, and he thinks it's doable - although we didn't go into details about the SSO spec</ref>
 
| 3-6 <ref>Already spoke with Mark, and he thinks it's doable - although we didn't go into details about the SSO spec</ref>
| Discuss with Jared, Aran and Mark the feasibility of using the MW SSO extension
+
| Discuss the feasibility of using the MW SSO extension with Jared, Aran and Mark Hershberger.
 
|-
 
|-
 
| 8-16  
 
| 8-16  
| If this SSO extension appears feasible, set up the DCS Wiki without its SSO and authentication, in a QualityBox MWaaS instance on your PC. Linux and MW versions are selected to ease migration problems so do not have to be, and probably shouldn’t, be the latest versions.   
+
| If this SSO extension appears feasible, set up the DCS Wiki without its SSO and authentication, in a QualityBox MWaaS instance on a local virtual machine. Linux and MW versions are selected to ease migration problems.   
 
|-
 
|-
| ??<ref>depends on #1 to find out what work is entailed on the Rails side.</ref>  
+
| ??<ref>Depends on #1 to find out what work is entailed on the Rails side.</ref>  
 
| If successful, the intention is to migrate to a DO server to implement the SSO extension with Jared.
 
| If successful, the intention is to migrate to a DO server to implement the SSO extension with Jared.
 
|-
 
|-
 
| ??  
 
| ??  
| If the MW SSO extension is not feasible, develop a plan B <ref>narrow the footprint of the code during configuration, initialization and dependencies for easy by-pass in testing and/or mock data and routines for "LocalTesting"</ref> to achieve Objective #1.  
+
| If the MW SSO extension is not feasible, develop a plan B <ref>Narrow the footprint of the code during configuration, initialization and dependencies for easy by-pass in testing and/or mock data and routines for "LocalTesting"</ref> to achieve Objective #1.  
 
|-
 
|-
| 20 <ref>I've already completed most of this effort with about 15 hours logged</ref>
+
| 5 <ref>I've already completed most of this effort with about 15 hours logged</ref>
| In either event, completing and consolidating the list of active DCS’ extensions, including category (Regular, Custom DCS, Organic Design, etc), lines of code, type of code, and other useful columns, including questions and recommendations to be discussed with Aran.  This can be in wiki format, but not in Github.
+
| In either event, completing and consolidating the list of active DCS’ extensions, including category (Regular, Custom DCS, Organic Design, etc), lines of code, type of code, and other useful columns, including questions and recommendations to be discussed with Aran.
 
|}
 
|}
  
{{References}}
+
== Footnotes ==
 +
<References />

Revision as of 13:45, 31 May 2018

Priorities[edit | edit source]

  1. Migrate the DCS Wiki to QualityBox’s MWaaS, fully integrated with the Rails App, upgraded to Ubuntu 18.04 LTS (or other 2018 Linux LTS) and MW 1.31 LTS.
  2. Understand the DCS Wiki so as to be able to make any bug fixes and minor improvements requested by Matt.
  3. Increase the maintainability of the DCS Wiki by rewriting and replacing extensions. Not a major priority now, but will be once the migration has been successful.

Progress Report / Work Summary[edit | edit source]

  • Failed attempt to transfer DCS Wiki, as is, to QualityBox. Reason: complexity and way the current SSO and authentication code is woven into LocalSettings (configuration) and other extensions (code).
  • 100% coverage and review of the extension inventory. Need to still reformat (consolidate); remove unused extensions; and get input from Aran or get more detail on how to achieve priorities.

Evaluation of progress in achieving priority objectives[edit | edit source]

  1. Uncovered the Apache configuration and also the document root and include paths for extensions. Rewrote mod_rewrite rules into working .htaccess rules. Still need to setup a local test environment where debugging, DNS and code changes would be easier. This is on the work plan for June.
  2. After finally reviewing the existing documentation and most of the ~6600 lines of code in the DCS extensions, I would say that I'm fairly comfortable with making any bug fixes or minor improvements. A working local test/debug environment would go a long way towards making me very comfortable.
  3. After reviewing the existing codebase, the time period it was developed, the lineage, or history of the code and functionality it offers compared with my knowledge of alternatives or current MediaWiki core, I've begun to find ways in which DCS can eliminate or reduce work load, technical debt, and bring the wiki more into conformance with a standard "QualityBox" wiki setup. When finally deployed on QualityBox, there will still be maintenance, but the system will be at "peak maintainability".


June Work Plan (with estimated range of hours)[edit | edit source]

Est. Hours Work
3-6 [1] Discuss the feasibility of using the MW SSO extension with Jared, Aran and Mark Hershberger.
8-16 If this SSO extension appears feasible, set up the DCS Wiki without its SSO and authentication, in a QualityBox MWaaS instance on a local virtual machine. Linux and MW versions are selected to ease migration problems.
??[2] If successful, the intention is to migrate to a DO server to implement the SSO extension with Jared.
?? If the MW SSO extension is not feasible, develop a plan B [3] to achieve Objective #1.
5 [4] In either event, completing and consolidating the list of active DCS’ extensions, including category (Regular, Custom DCS, Organic Design, etc), lines of code, type of code, and other useful columns, including questions and recommendations to be discussed with Aran.

Footnotes[edit | edit source]

  1. Already spoke with Mark, and he thinks it's doable - although we didn't go into details about the SSO spec
  2. Depends on #1 to find out what work is entailed on the Rails side.
  3. Narrow the footprint of the code during configuration, initialization and dependencies for easy by-pass in testing and/or mock data and routines for "LocalTesting"
  4. I've already completed most of this effort with about 15 hours logged