task #2091
openImprove DataPortal documentation
60%
Description
The DataPortal documentation needs to be improved.
Currently different texts on the DataPortal are spread over multiple pages and websites:
General¶
CDM DataPortal in the Wiki: https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CDM_DataPortal
Cdm Dataportal ImplementationNotes: https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CdmDataportalImplementationNotes
CDM DataPortal - Druapl Project: http://drupal.org/project/cdm_dataportal
FAQ¶
all faq need to be moved to the new maven product site at http://cybertaxonomy.eu/portal/
CDM DataPortal User FAQ: https://dev.e-taxonomy.eu/trac/wiki/CDMDataPortalUserFaq
CDM DataPortal Admin FAQ: -- does not exist jet ---
Installation¶
_All texts on general installation procedures will be located in future only in the CDM Bundle Site
CDM DataPortal Install Guide in this wiki: https://dev.e-taxonomy.eu/trac/wiki/CDMDataPortalInstall
CDM DataPortal Install Guide in the CDM Bundle Site
A selection of texts on the DataPortal from former publications¶
EDIT Data Portal
The EDIT Data Portal publishes data hosted in a CDM Community Store online.
Each taxon is represented by an individual page, which displays the list of synonyms, related taxa, occurrences, descriptions, media, and more. The list of homotypic and heterotypic synonyms is ordered historically and grouped by types.
It has been implemented as a module for the content management system Drupal. Thus the EDIT Data Portal offers a great deal of flexibility making it possible to adapt the EDIT Data Portal to the individual needs of a community.
Drupal as multipurpose tool and application framework for biodiversity information networks
The open source content management system Drupal becomes more and more widely used in the area of biodiversity informatics. This year, for example, the members of the EDIT project assigned a memorandum of understanding to use this software, where ever possible.
This popularity is not only due to its capabilities to just manage content for websites. The genius of what the Drupal community has done, is to reduce all of the aspects of social software to the core and then build a platform that could be infinitely extended to allow the assembly of almost any styles of online social interaction. During the past years the community contributed over 3000 different modules extending the Drupal core and thus on one hand providing a highly flexible construction kit and on the other hand showing by many examples that nearly everything is possible, perhaps only limited by the human imagination.
Constructing the ‘EDIT platform for cybertaxonomy’ Drupal is used to build up general web applications like forums, blogs, a central repository for users and taxonomists, the ‘Experts Database’ and a software tracker and rating system. Last but not least also taxonomy related software like the ‘Scratchpads’ and the ‘CDM DataPortal’ is based on this system.
The ‘CDM DataPortal’ is using Drupal as an application framework to publish taxonomic treatments to a closed community or to the public. The treatments, stored in database are, accessible via web services to which the ‘CDM DataPortal’ connects to fetch the information to be displayed. Furthermore does the ‘CDM DataPortal’ act as an easy to use web service allowing reusing fragments of its pages in other contexts already rendered as HTML.
The new TDWG standards architecture relies among others on semantic web technologies, which are tailored around a data format called RDF. Unfortunately there has always been a lack of common tools for easy processing and visualising data provided by the RDF based ontology.
Since the last big version switch to Drupal 6, some very interesting modules are being simmered, which will allow storing, aggregating and processing RDF data, making Drupal an highly interesting candidate for building applications which benefit from the new semantic capabilities of the TDWG standards architecture. Drupal is promising not only because of the interesting technical implementations but also because of its popularity and support from a vast community.
Some RDF related modules are already available although most of them still are in alpha status. One of these incorporates RDF taxonomies into Drupal, another one is actually an ensemble of modules providing comprehensive RDF functionality and interoperability.
With ‘Exhibit’ and ‘Potluck’ the SIMILE (Semantic Interoperability of Metadata and Information in unLike Environments) project of the MIT has developed interesting tools for visualizing, browsing and mixing data. Exhibit for example displays structured data in the form of rich visualizations that can be searched, filtered and sorted using faceted browsing. The Exhibit module will bring these abilities to Drupal.
Tools for efficiently using the TDWQG RDF ontology are in reach and await their evaluation. So the time has come to find out what is possible to vision the next generation biodiversity network tools.
Related issues
Updated by Andreas Kohlbecker over 12 years ago
@Paco: isn't this already fixed?
Updated by Patrick Plitzner about 10 years ago
There is a sentence which should probably be rewritten as it does not make sense/is hard to understand:
on http://wp5.e-taxonomy.eu/portal/installation.html
"Once you have been installed Drupal and CDM Data Portal Module is enabled you will find how to configure the CDM Data Portal Module inside Drupal itself."
Updated by Andreas Kohlbecker about 10 years ago
- Priority changed from Highest to Priority14
Updated by Andreas Müller about 1 year ago
- Description updated (diff)
- Assignee changed from Andreas Kohlbecker to Andreas Müller
- Target version changed from cdm_dataportal - Next Major Release to Update Documentation
Updated by Andreas Müller about 1 year ago
- Due date set to 03/31/2022
- Assignee changed from Andreas Müller to Katja Luther
- Target version changed from Update Documentation to Release 5.31
- Start date set to 03/11/2022
Updated by Andreas Müller about 1 year ago
- Status changed from New to In Progress
- % Done changed from 0 to 20
Updated by Andreas Müller about 1 year ago
- Related to task #8863: Create full documentation on multilingual setup of the Data Portal added
Updated by Katja Luther about 1 year ago
- Moved CdmDataportalBookmarks CdmDataportalBookmarks to Archive
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 #9993: Move markdown from code to developer wiki added
Updated by Andreas Müller 12 months ago
- Due date changed from 03/31/2022 to 04/05/2022
- % Done changed from 50 to 70
Updated by Katja Luther 12 months ago
- Status changed from In Progress to Resolved
- % Done changed from 70 to 100
Restructured pages and removed outdated pages. Documentation of installation issues improved.
Updated by Andreas Müller 12 months ago
- Related to task #9954: Refactor EDIT Platform (Wiki) Documentation added
Updated by Katja Luther 12 months ago
- Assignee changed from Katja Luther to Andreas Müller
- % Done changed from 100 to 80
Updated by Katja Luther 12 months ago
- Due date changed from 04/05/2022 to 04/08/2022
Updated by Andreas Müller 11 months ago
removed the outdated "CDM Dataportal Demo Sites" block by a link to reference projects on cybertaxonomy.org
Updated by Andreas Müller 11 months ago
Open issues:
- move all content from https://cybertaxonomy.org/portal/ to https://cybertaxonomy.org/portal2/ : DONE for text but menu still needs to be migrated
- menu "Dataportal installation" may link to https://cybertaxonomy.org/dataportal/installation
- Screenshots: we may put 2-3 screenshots on the CDM Data Portal page, for all the rest we have the "references" page
- Releases and downloads: 1 line linking to the current links
- Admin FAQ:
- decide on pages https://cybertaxonomy.org/setups/group/dataportal_requirements and https://cybertaxonomy.org/dataportal/requirements : can we merge these pages and do we need them at all? Are they linked from somewhere? => They are linked from pages like https://cybertaxonomy.org/setups/group; Content needs to be updated. The content of these pages mainly covers windows, so this should be mentioned at the beginning of the page.
- the content is identical
- group and community installation "book" links to https://cybertaxonomy.org/setups/group/dataportal_requirements
- from community installation the dataportal link points to https://cybertaxonomy.org/portal/
- https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CDMDataPortalUserFaq contains User information and therefore probably needs to be moved to cybertaxonomy.org
- this site is outdated.
- where to put https://cybertaxonomy.org/portal/admin-faq.html ? And does it need update?
- Most of the information of this site is not valid anymore, so we should remove it or update it
add some text on https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CDM_DataPortal#Environment-Setup-Drupal-Apache-Php-MySQL-PhpStorm what to do first, setting up PHPStorm or the "Requirements" and maybe explain what it for what- do we need the install part on https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/CDM_DataportalDevelopmentRequirements : how far does it differ from https://cybertaxonomy.org/dataportal/installation ; can we reduce redundancy?
- these pages are nearly identical, https://cybertaxonomy.org/dataportal/installation contains information about how to connect to the cdm server and how to enable/disable themes, this is missing on the other site.
Can we switch Update method1 and method2 as method2 is the recommended one?- Also we could think about moving the update section to cybertaxonomy.org as this is something also ordinary admins usually have to do.
- Move information from Drupal to [CDM_DataPortal] or do we want to keep this node as there are also other Drupal instances? If so should we move it to Software?
- I think we should keep it as an extra node because it is an important and independent issue. Maybe we can link it from the dataportal section and the software section?
- Include link for how to install a new instance.
Updated by Andreas Müller 11 months ago
- Due date changed from 04/08/2022 to 04/19/2022
- Status changed from Resolved to Feedback
- Assignee changed from Andreas Müller to Katja Luther
- Target version changed from Release 5.31 to Release 5.32
- Start date changed from 03/11/2022 to 04/01/2022
- % Done changed from 80 to 60
There are still a couple of open issues therefore I move this to the current milestone. We may discuss the open issues in the ticket review.
Updated by Andreas Müller 11 months ago
- Related to task #9991: Move content for users and admins from site.xml's to cybertaxonomy.org/drupal added
Updated by Andreas Müller 11 months ago
- Related to task #3482: Dataportal administration documentation added
Updated by Andreas Müller 8 months ago
- Target version changed from Release 5.32 to Release 5.33
Updated by Andreas Müller 6 months ago
- Target version changed from Release 5.33 to Release 5.37