Project

General

Profile

Actions

task #9954

closed

Refactor EDIT Platform (Wiki) Documentation

Added by Andreas Müller about 2 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Highest
Category:
documentation
Target version:
Start date:
03/11/2022
Due date:
03/31/2022
% Done:

100%

Estimated time:
30:00 h
Severity:
normal

Description

Aim: Allow developers to navigate easily to information they need

How to:

  • Organize structure
    • Add TOC and child notes information to every page
  • Analyze structure to find and merge redundant information
  • Create overview pages that give explaining links to subpages and to pages with related information => will be handled within the sub-tickets
  • Remove 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": #10031
    • Literature 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

Related to EDIT - bug #9990: Improve TaxEditor documentationNewKatja Luther05/09/202205/11/2022

Actions
Related to EDIT - task #2091: Improve DataPortal documentationFeedbackKatja Luther04/01/202204/19/2022

Actions
Related to EDIT - feature request #786: Write Developers Guide for CDM LibraryNewAndreas Müller04/19/202204/22/2022

Actions
Related to EDIT - task #10023: Update CDM Server documentationNewAndreas Müller

Actions
Related to EDIT - task #10024: Update other platform components documentationNewAndreas Müller

Actions
Related to EDIT - task #10025: Update other platform pages in wikiNewAndreas Müller

Actions
Related to EDIT - task #10026: Update DataModelsAndFormatsNewAndreas Müller

Actions
Related to EDIT - task #10027: Update DevelopmentNotesNewAndreas Müller

Actions
Related to EDIT - task #10028: Update Taxonomy NotesNewAndreas Müller

Actions
Related to EDIT - task #10029: Update other main groups and main pageNewAndreas Müller

Actions
Related to EDIT - task #9992: Move content for developers from site.xml's to developer WikiNewAndreas Müller04/19/202204/22/2022

Actions
Related to EDIT - task #10032: Create media metadata service documentationNewAndreas Müller

Actions
Related to EDIT - task #9994: Tasks from documentation meeting 3/22ClosedAndreas Müller04/01/202204/08/2022

Actions
Actions #1

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
  • Status changed from New to Discussed
Actions #2

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #3

Updated by Andreas Müller about 2 years 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

Actions #4

Updated by Andreas Müller about 2 years ago

  • Priority changed from New to Highest
  • Target version changed from Release 5.45 to Release 5.31
Actions #5

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #6

Updated by Andreas Müller about 2 years ago

  • % Done changed from 20 to 30
Actions #7

Updated by Andreas Müller about 2 years ago

  • % Done changed from 30 to 40
Actions #8

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #9

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #10

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #11

Updated by Andreas Müller about 2 years ago

  • % Done changed from 40 to 50
Actions #12

Updated by Katja Luther about 2 years 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

Actions #13

Updated by Andreas Müller about 2 years ago

  • Related to bug #9990: Improve TaxEditor documentation added
Actions #14

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #15

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #16

Updated by Andreas Müller about 2 years ago

  • Related to task #2091: Improve DataPortal documentation added
Actions #17

Updated by Andreas Müller about 2 years ago

Actions #18

Updated by Andreas Müller about 2 years ago

  • Related to task #10023: Update CDM Server documentation added
Actions #19

Updated by Andreas Müller about 2 years ago

  • Related to task #10024: Update other platform components documentation added
Actions #20

Updated by Andreas Müller about 2 years ago

  • Related to task #10025: Update other platform pages in wiki added
Actions #21

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #22

Updated by Andreas Müller about 2 years ago

  • Related to task #10026: Update DataModelsAndFormats added
Actions #23

Updated by Andreas Müller about 2 years ago

  • Related to task #10027: Update DevelopmentNotes added
Actions #24

Updated by Andreas Müller about 2 years ago

Actions #25

Updated by Andreas Müller about 2 years ago

  • Related to task #10029: Update other main groups and main page added
Actions #26

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #27

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #28

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #29

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #30

Updated by Andreas Müller about 2 years ago

  • Related to task #9992: Move content for developers from site.xml's to developer Wiki added
Actions #31

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #32

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #33

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #34

Updated by Andreas Müller about 2 years ago

  • Related to task #10032: Create media metadata service documentation added
Actions #35

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #36

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #37

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #38

Updated by Andreas Müller about 2 years 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.

Actions #40

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #41

Updated by Andreas Müller about 2 years ago

  • Related to task #9994: Tasks from documentation meeting 3/22 added
Actions

Also available in: Atom PDF