[[BackLinksMenu]] [[TicketQuery(summary=SCS_WIKI_MAINTENANCE_R2, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|)]] = Analysis = == Overview == Wiki maintenance assures that the wiki is in perfect usable condition. == Task requirements == In this revision the requirements are: * Delete the obsolete page templates * Create an iteration page template (see [wiki:ITERATION_03]) * Review and repair the duplicate information (or at least - start doing it) See implementation idea for this. * Make sure you've repaired the links in documents that point to a page that you've renamed! * Add ![[BackLinksMenu]] to all of the pages in ImportantDocs == Task result == Maintained wiki. == Implementation idea == Here is a list of pages that contain almost the same (or overlapping) information, missing links, etc.: [wiki:PROCESS] [[BR]] [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] - the repository section should be linked as a part of [wiki:PLATFORM_STANDARDS_REPOSITORY] [[BR]] [wiki:PLATFORM_STRUCTURE] should be linked in [PLATFORM_STANDARDS_REPOSITORY] [[BR]] [wiki:PLATFORM_STANDARDS_NAMING_CONVENTION] - should be discussed with the team leader and filled in with: * Repository naming convention (don't know where it can be found now * Wiki naming convention (now part of [PLATFORM_STANDARDS_GENERAL] * Developers id convention * Move the naming convention for reports found in [wiki:REPORTS] and link it there * Move [wiki:NAMING_CONVENTIONS] here * Move and update [wiki:UnplannedTasks] This document should be linked where needed. [[BR]] * [wiki:TESTING] should be renamed to [wiki:PLATFORM_STANDARDS_AUTO_TESTS] * See backlinks and repair the references before renaming! * Link testing in [wiki:PLATFORM_STANDARDS_GENERAL] as it is done for analysis and design * See [wiki:PLATFORM_STANDARDS_CODE_R0] and rename the resulting pages due to the wiki convention * Review and remove obsolete information from Important Docs == Related == ^(Here you can add related tasks that could be useful or helpful.)^ == How to demo == Show some of the corrected pages and explain the improvements you made. = Design = * Create section with information about holidays in the iteration page (that was added as requirement after the analysis) * use table structure * mark workdays and holidays * write down the important events on their dates (weeklies, progress checks, etc.) * Remove obsolete page templates * See [wiki:PageTemplates] * Iteration page template content {{{ == Related Tickets == [[TicketQuery(group=status,order=owner,milestone=MILESTONE_NAME,format=table,col=summary|owner|status|type|component|priority|effort|importance)]] }}} * List with pages without ![[BackLinksMenu]], linked in ImportantDocs * [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] * [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE] * [wiki:PLATFORM_STRUCTURE] * [wiki:PLATFORM_STANDARDS_GENERAL] * [wiki:PLATFORM_STANDARDS_ANALYSIS] * [wiki:GLOBAL_SPEC_STRUCTURE] * [wiki:JAVADOC_CONVENTIONS] * [wiki:NAMING_CONVENTIONS] * [wiki:CODE_TASKS_REQUIREMENTS] * [wiki:CODE_SMELLS] * [wiki:License] * Obsolete pages that must be deleted * [wiki:READ_DOCS] - it is empty and we already keep such record in our internal backlog. * [wiki:SPRINT_LOGS] - it is empty, and the summaries that we're sending in the dev mailist and post in the blog, make this page obsolete. * [wiki:OPEN_QUESTIONS] - it is empty and we already keep such record in our internal backlog. * Repository documents are now gathered and structured in [wiki:PLATFORM_STANDARDS_REPOSITORY], that was part of another task * Remove the overlapping information from [wiki:PROCESS], [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] and etc. if possible (due to the little effort of this revision) * Move the following part from [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] to [wiki:PLATFORM_STANDARDS_REPOSITORY] and create link in [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] (when applying this section to the repo page use bullet structure). {{{ ==== Deploying a project in a repository ==== * Checkout the project repository * In Windows: 1. Right-click in a new empty folder and choose "Create repository here" option from the TortoiseSVN submenu. 1. Choose "SVN Checkout...". Enter the URL of the repository of the Sophie2 project. The URL is SVN://asteasolutions.net:7369/sophie2. 1. Choose your checkout directory(sophie2-repo). It is set by default to be the empty folder in which you choose "SVN Checkout...". 1. Write your username and password for the repo. Now you have local project repository. * In Mac/Linux: 1. Open Terminal 1. use the command svn checkout SVN://asteasolutions.net:7369/sophie2 sophie2 Build the project in Eclipse by following the instructions on the [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE Eclipse Integration] page. }}} * Rename [wiki:TESTING] to [wiki:PLATFORM_STANDARDS_AUTO_TESTS] * content of [wiki:TESTING] must be moved to [wiki:PLATFORM_STANDARDS_AUTO_TESTS] * make sure that you corrected all pages linking to [wiki:TESTING] * [wiki:TESTING] must be removed * Same way rename all pages in [wiki:ImportantDocs] so that all have same convention. * Remove the entry for [wiki:PLATFORM_STANDARDS_MANUAL_TESTS_R0] from [wiki:ImportantDocs] it doesn't belong there * Reorder [wiki:ImportantDocs] using the following order {{{ [[BackLinksMenu]] [wiki:DEVELOPMENT_OVERVIEW] [wiki:PROCESS] [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE] [wiki:PLATFORM_STRUCTURE] [wiki:PLATFORM_STANDARDS_GENERAL] [wiki:PLATFORM_STANDARDS_ANALYSIS] [wiki:PLATFORM_STANDARDS_REPOSITORY] [wiki:PLATFORM_STANDARDS_AUTO_TESTS] [wiki:REPORTS] [wiki:GLOBAL_SPEC_STRUCTURE] [wiki:COMPILER_SETTINGS] [wiki:JAVADOC_CONVENTIONS] [wiki:NAMING_CONVENTIONS] [wiki:LOGGING] [wiki:CODE_TASKS_REQUIREMENTS] [wiki:CODE_SMELLS] [wiki:USEFUL_LINKS] [wiki:SophieWishlist] [wiki:License] }}} * Creating [wiki:PLATFORM_STANDARDS_NAMING_CONVENTION] must be included in other tasks, because this has too little effort = Implementation = * Created table with the schedule of the workdays during the holidays, it is included in [wiki:ITERATION_03] * Added ![[BackLinksMenu]] to the following pages * [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] * [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE] * [wiki:PLATFORM_STRUCTURE] * [wiki:PLATFORM_STANDARDS_GENERAL] * [wiki:PLATFORM_STANDARDS_ANALYSIS] * [wiki:GLOBAL_SPEC_STRUCTURE] * [wiki:JAVADOC_CONVENTIONS] * [wiki:NAMING_CONVENTIONS] * [wiki:CODE_TASKS_REQUIREMENTS] * [wiki:CODE_SMELLS] * [wiki:License] * Removed obsolete pages * [wiki:READ_DOCS] - it is empty and we already keep such record in our internal backlog. * [wiki:SPRINT_LOGS] - it is empty, and the summaries that we're sending in the dev mailist and post in the blog, make this page obsolete. * [wiki:OPEN_QUESTIONS] - it is empty and we already keep such record in our internal backlog. * Removed the entry for [wiki:PLATFORM_STANDARDS_MANUAL_TESTS_R0] from [wiki:ImportantDocs] * Reorder [wiki:ImportantDocs] using the order suggested in the design * Removed the two unnecessary page templates * Added page template for iteration page, it is available at [wiki:PageTemplates/IterationPageTemplate] * Moved the following part from [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] to [wiki:PLATFORM_STANDARDS_REPOSITORY] and create link in [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW] (when applying this section to the repo page use bullet structure). {{{ ==== Deploying a project in a repository ==== * Checkout the project repository * In Windows: * Right-click in a new empty folder and choose "Create repository here" option from the TortoiseSVN submenu. * Choose "SVN Checkout...". Enter the URL of the repository of the Sophie2 project. The URL is SVN://asteasolutions.net:7369/sophie2. * Choose your checkout directory(sophie2-repo). It is set by default to be the empty folder in which you choose "SVN Checkout...". * Write your username and password for the repo. Now you have local project repository. * In Mac/Linux: * Open Terminal * use the command svn checkout SVN://asteasolutions.net:7369/sophie2 sophie2 Build the project in Eclipse by following the instructions on the [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE Eclipse Integration] page. }}} * Removed the overlapping information from [wiki:PROCESS], [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW]. * Renamed [wiki:TESTING] to [wiki:PLATFORM_STANDARDS_AUTO_TESTS], corrected all pages linking to [wiki:TESTING]. * Applied all other part of the design phase. = Testing = = Comments = ^(Write comments for this or later revisions here.)