| | 1 | [[BackLinksMenu]] |
| | 2 | |
| | 3 | [[TicketQuery(summary=UNPLANNED_DEVELOPMENT_OVERVIEW, compact)]] |
| | 4 | |
| | 5 | = Analysis = |
| | 6 | |
| | 7 | == Overview == |
| | 8 | The goal of this task is to collect all the necessary information for new contributors to the project in a single wiki page. |
| | 9 | |
| | 10 | == Task requirements == |
| | 11 | Review all the introductory wiki pages and correct the mistakes. |
| | 12 | Write a new wiki page, linking to the old ones |
| | 13 | * Each link should be preceeded by an introductory paragraph. |
| | 14 | * The new wiki should provide all that new members of the team need in order to get started. |
| | 15 | * Internal information should not be widely accessible. |
| | 16 | |
| | 17 | == Task result == |
| | 18 | The result of this task is a wiki page. |
| | 19 | |
| | 20 | == Implementation idea == |
| | 21 | Follow the step-by-step instructions on the introductory wiki pages (listed in the related section) and correct any mistakes or ambiguity you encounter. |
| | 22 | |
| | 23 | == Related == |
| | 24 | [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW][[BR]] |
| | 25 | [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE][[BR]] |
| | 26 | [wiki:PROCESS][[BR]] |
| | 27 | [wiki:REPORTS][[BR]] |
| | 28 | [wiki:PLATFORM_STANDARDS_ANALYSIS_R0] |
| | 29 | |
| | 30 | == How to demo == |
| | 31 | Show the new wiki page to the team. |
| | 32 | |
| | 33 | = Design = |
| | 34 | '''1)''' The correction of the mistakes is already described in the analysis. [[BR]] |
| | 35 | '''2)''' Create new page [wiki:DEVELOPMENT_OVERVIEW] containing: |
| | 36 | * Basic knowlegde paragraph, containing short definitions and links to related manuals. Sub-paragraphs: SVN, Maven, Eclipse, Trac, JDK |
| | 37 | * Setup paragraph, containing step-by-step information how to load sophie2. Sub-paragraphs: |
| | 38 | * '''SVN'''; |
| | 39 | * '''Repository''': installation, writing reports; |
| | 40 | * '''Maven'''; |
| | 41 | * '''Eclipse''': installation, compiler settings, subclipse instalation, maven plugin instalation, importing Sophie, running Sophie |
| | 42 | * Tasks paragraph. Two sub-paragraphs: '''Process''', describing its importance, as well as a link to the Proccess page; '''Performing tasks''', which must include links to how to write analysis, task tips, coding(Code Tasks Requirements, coding conventions, code smells,writing javadoc, logging) and testing(manual/auto tests). |
| | 43 | * Sophie2 paragraph: |
| | 44 | * Overview. Link to the planned Sophie intro. |
| | 45 | * Aspects of Sophie. |
| | 46 | * Modularity, describing the idea of modules, as well as a link to the "writing modules" tutorial. Extensions and extension points, too. |
| | 47 | * Structure, linking to PLATFORM_STRUCTURE. Some explanations may be useful. |
| | 48 | * Properties, linking to the properties tutorial |
| | 49 | * MVC, and a link to the MVC tutorial |
| | 50 | * Development Issues. Must include descriptions of the main task categories, e.g. Sophie Platform(Platform Design, Plugin Architecture, Core, Base, Features), Sophie Server, Sophie end product, Project Community, Supporting Artifacts. [[BR]] |
| | 51 | * Getting help paragraph, with explanation how to ask if a problem comes out (for example, link to the forums). |
| | 52 | * Useful links. This document is located in "important docs". |
| | 53 | ''' Most of these documents are already written. According to the analysis, every paragraph must have a link to the corresponding wiki document (if it exists).''' |
| | 54 | = Implementation = |
| | 55 | ^(Implementation results should be described and linked here (from the wiki or the repository))^ |
| | 56 | |
| | 57 | = Testing = |
| | 58 | |
| | 59 | = Comments = |
