task #9954
closedRefactor EDIT Platform (Wiki) Documentation
100%
Description
Aim: Allow developers to navigate easily to information they need
How to:
Organize structureAdd TOC and child notes information to every page
Analyze structure to find and merge redundant information- CDM DataPortal (#2091)
- TaxEditor (#9990)
- CDM Library (#786)
- CDM Server (#10023)
- Phycobank and Webeditor (#10030)
- Geocomponents (#10031)
- Media metadata service (#10032)
- Other Platform Components (PlatformComponents) (#10024)
- Other EDIT Platform pages (EDIT_Platform) (#10025)
- Data Models and Formats (DataModelsAndFormats) (#10026)
- DevelopmentNotes (DevelopmentNotes) (#10027)
- TaxonomyNotes (TaxonomyNotes) (#10028)
- Other main groups (#10029)
Create overview pages that give explaining links to subpages and to pages with related information=> will be handled within the sub-ticketsRemove pure milestone/version pages and move descriptions to the version.description field (keep only pages with descriptions >255 characters, but move them to archive- Move information for platform to cybertaxonomy.org as far as possible
- keep roadmap roadmap ?
- manuals
- information for workshops
- project related information
Add information on new components (UTIS, Webbrowser (Vaadin), MediaMetaDataService, GeoCache, ...)- Decide on site.xml pages => should be fully removed or reduced to a minimum with links only (#9992)
Decide on README.md files for component documentation=> should be removed and content merged with content on component sites or cybertaxonomy.org user/admin sites
~~Sidebar: ~~
- Components
send retired components to archive (CSSO, ExpertsDB, BDTracker)- add new components
move Roadmap to top level
- Other
- remove "Community Websites" as it is an "Components Overwiew", maybe add an "Overview" page to "Components" instead or link to according cybertaxonomy.org page
- remove "Architecture" as it is outdated, add a new architecture site (with updated figures) to "Components" instead
- Use-Cases: update the usecases (#10025)
Geographic Components: Update and add to "Components": #10031Literature Components: Remove completely or move to archive
Decisions from Mar 18th 22:
- we start with platform component sites to fully cleanup
- sites follow syntax CDM_DataPortal_XXX, TaxEditor_XXX, CDM_Library_XXX, ...
- old sites will be moved to an archive folder within the platform folder
- typical subpages will be Intro, Install, FAX, Getting Started(?), Components, BestPractices, ...
Related issues
Updated by Andreas Müller over 1 year ago
- Description updated (diff)
- Status changed from New to Discussed
Updated by Andreas Müller about 1 year ago
- Due date set to 03/31/2022
- Start date set to 03/11/2022
- % Done changed from 0 to 20
- Estimated time set to 30:00 h
Move open issues to new milestone after 5.31 release
Updated by Andreas Müller about 1 year ago
- Priority changed from New to Highest
- Target version changed from Release 5.40 to Release 5.31
Updated by Katja Luther about 1 year ago
All pages now follow the guideline from https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/Redmine_Best_Practice .
For dataportal part the developer instruction for setting up the environment was updated.
For dataportal and taxeditor a first round of moving outdated pages to the archive
Updated by Andreas Müller about 1 year ago
- Related to bug #9990: Improve TaxEditor documentation added
Updated by Andreas Müller about 1 year ago
- Related to task #2091: Improve DataPortal documentation added
Updated by Andreas Müller about 1 year ago
- Related to feature request #786: Write Developers Guide for CDM Library added
Updated by Andreas Müller about 1 year ago
- Related to task #10023: Update CDM Server documentation added
Updated by Andreas Müller about 1 year ago
- Related to task #10024: Update other platform components documentation added
Updated by Andreas Müller about 1 year ago
- Related to task #10025: Update other platform pages in wiki added
Updated by Andreas Müller about 1 year ago
- Related to task #10026: Update DataModelsAndFormats added
Updated by Andreas Müller about 1 year ago
- Related to task #10027: Update DevelopmentNotes added
Updated by Andreas Müller about 1 year ago
- Related to task #10028: Update Taxonomy Notes added
Updated by Andreas Müller about 1 year ago
- Related to task #10029: Update other main groups and main page added
Updated by Andreas Müller about 1 year ago
- Related to task #9992: Move content for developers from site.xml's to developer Wiki added
Updated by Andreas Müller about 1 year ago
- Related to task #10032: Create media metadata service documentation added
Updated by Andreas Müller about 1 year ago
- Description updated (diff)
- Status changed from Discussed to Closed
- % Done changed from 50 to 100
The wiki pages have been reordered and hierarchically structured. Parent pages were created. Decisions about how and where to document were made.
Subparts of the documentation still need to be updated. According tickets werde created so we can close this "start up" ticket.
Updated by Andreas Müller about 1 year ago
- Related to task #9994: Tasks from documentation meeting 3/22 added