Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Problems with the Components Page
Revision as of 18:08, 5 December 2008 by Ptrevithick.gmail.com (Talk | contribs)
{{#eclipseproject:technology.higgins}}
Problems
General
- Lack of adherence to definition of component as a service description (analogous to a Java interface)
- Some tables comprise N>1 component --this should no longer be allowed
- projects (rows) within a component should be marked as either being (a) alternate implementations of the component contract for different runtime environments/languages, etc. or (b) separate constituent projects that taken together implement the component contract
- Some tables/sections use the same component name for different services (e.g. HBX4FF is a different service than Firefox Embedded HBX)
- Broken links to download pages (need to suppress display of the link)
- Lack of consistency in names of wiki pages at "component" level vs. "project" level
- Lack of precise definitions of "Component" and "Project", etc. has contributed to confusion
- Lack of adherence to one row = one project (e.g. tcpserver)
- Broken links in "Owner" column (Tie Li, Paula, Andy)
- Lack of LED build indicators (can't remember if we've given up on this or not)
- Many missing "First check=in" values (SVN tags)
- Some projects have poor names (e.g. cbselector, crpps, etc.
Proposed Fixes
- For projects/rows: enforce name of project (all lowercase) = org.eclipse.higgins.[name] = name of wiki page
- Create (precise) definitions of "Component" and "Project" terms. Add definitions to Components Page Conventions
- Comb through the Components page tables and
- tweak the table macro to enforce latest rules (allow downloads link suppression, enforce wiki page name == project name)
- edit the tables to conform to the latest rules
- break up tables in some cases
- Change hierarchical structure of table as follows:
- add a grey (mid level) row to introduce N subsequent ALTERNATIVE projects
- add a green? (new) (mid level) row to introduce N subsequent sub-projects (these N taken together implement the component contract)
- Break some projects into separate projects (e.g. tcpserver)
- Add a link http://wiki.eclipse.org/Higgins_SVN_Branch_Structure
- Disallow nesting/combination of components in a single table
- Rename poorly named projects
- Get after component owners to update contact links, rename projects