wiki:newContribDoc

A new generation of Wiki for Caixa Magica community

Project details

Licensing

GPL V2 (the current license used for all Caixa Mágica's internal projects)

Purpose of this project

The existing wiki for Caixa Magica, named Contribdoc, is outdated, has a poor navigation and low appeal. It is intended with this project to completely renew the existing wiki in order to have a powerful, scalable and intuitive documentation platform.

Project description

This project's goal is to migrate all the information contained in the existing wiki to a new platform. The new platform will be chosen based on a state of the art study of the existing wiki engines and which are used by other Linux distributions. The new wiki will have LDAP integration, a rich editor, and a custom layout with ease of use and scalability in mind.

Roadmap

  • Phase 1: State of the art study, choice of the engine and project planning.

Summary: Analysis of the existing contribdoc platform, wiki engines used by other Linux distributions and how their information is displayed. Choice of the wiki engine and preparation of the tools and extensions needed to achieve basic functionality. Creation of the wiki map, front page layout and menu layout.

Deadline: 19/July/2010

Deliverable: Wiki Layout

  • Phase 2: Basic Functionality Testing

Summary: LDAP authentication installation and testing, Rich text editor installation and testing. Testing and improvement of the migration script.

Deadline: 26/July/2010

Deliverable: Wiki with basic functionalities working on a test environment.

  • Phase 3: Skinning and formating

Summary: Creation of a custom skin, menus and sub-menus and front page. Organization of all the existing pages according to the new layout.

Deliverable: Complete Wiki working on a test environment.

Deadline: 30/August/2010

  • Phase 3a: Setting the new Wiki as the main wiki

Deadline: 30/August/2010

  • Phase 4: Development of extra functionalities

Summary: Development of hardware and problem solving templates. Creation of a template-based system to differentiate troubleshooting by the Caixa Magica version used.

Deadline: 13/September/2010

  • Phase 5: (Optional) Development of extra functionalities and rewriting of incomplete or deprecated wiki pages

Deadline: 17/September/2010

Risk Mitigation, Monitoring and Management Plan

Risks

  • There are conflicts between php versions which can cause wikimedia extensions to fail.
  • The wikimedia code documentations is non existant

Interaction with the community / Incentives to collaboration

The ContribDoc? platform is essential in the community and and the community is essential to ContribDoc?. The new wiki will be built with the community in mind and with a collaboration seeking approach.

Mentor information

Company

Caixa Mágica Software

Company description

Caixa Mágica is one of the open source projects with most historical background in Portugal.

Born in a college environment at ISCTE in 2000, has been growing steadily for the last eight years, supported by a set of visions, mission and values and a strategy the help maintaining the focus on open source technologies.

In 2004, a spin-off company started, being held a strong relationship with ADETTI through a contract of shared development. The company Caixa Mágica Software had positive results in 2004 and has been growing 30% each year.

Today, Caixa Mágica has 15 to 20 collaborators distributed along three main areas:

  • Product: engineering team that develops the Linux Caixa Mágica distribution.

Currently, about 900 units are sold each month, spread along online sales, store and special programs.

  • Outsourcing: projects that highly demand open source technologies and where our professionals are an added value.
  • Research: European and National projects that feed technology and competence to other business units. At the moment we have a cycle of three years from the initial research to product availability.

Added to the three main areas, Caixa Mágica has three more areas of smaller dimensions but growing: Training, Professional Services and Appliances.

Mentor

Pedro Fragoso

Pedro Fragoso is a Technical Consultant at Caixa Mágica. At the moment he is responsible for maintaining stable versions of the Linux Caixa Mágica distribution and also develop new versions of this distribution. He is also a senior researcher at O2H lab in ADETTI, researching operating systems and security.

Proposal URL

Trainee details

Name

Filipe Morais

Past experience

  • Academic knowledge in Java, C, assembly and bash.
  • Self-taught knowledge in php and bash.
  • Installation and configuration of xampp web servers at private level.
  • Installation and configuration of phpbb, joomla and mediawiki platforms at private level.
  • Development of Web Sites at private level.

Current situation

Will attend next year the second year in Computers and business management degree on ISCTE-IUL.

Development process adopted

  • Study of the current wiki architecture and the approach used by other linux distributions
  • Creation of a Wiki site map and a menu and front page layout
  • Development and migration
  • Improvements and development of extra functionalities

Motivation for the project

Linux and all its distributions are dependant on the community and the existence of a powerful documentation tool for this community is essential. It is expected that a new and appealing wiki will motivate Caixa Magica's users to contribute more often with their knowledge improving the documentation base and the community itself. Personally I expect to acquire more experience in a professional environment and improve my project development capabilities

Project documentation

References

Last modified 8 years ago Last modified on Jul 23, 2010, 7:05:42 PM

Attachments (2)

Download all attachments as: .zip