Improve documentation

[skasberger]

Improve documentation by adapting pyDataverse docs.

Requirements

• Base upon pyDataverse docs
• Pages
  • Homepage
  • Contributor Guide
  • FAQ
  • Resources
  • Contact
  • Installation
  • Releases
  • Basic User Guide
  • API/Reference

ACTIONS

0. Pre-Requisites

1. Plan

• Define requirements

2. Design

• [ ]

3. Implement

Minor bits

• add import_csv and delete_all_dois commands #11 (comment)
• DOIs which are not valid, are not processed
• Same URLs are mapped to different FB objects (see altmetrics paper)
• drawing: pipeline

Pipeline

Pipeline / Project Structure

1. Preprocessing: Collect URLs and DOIs

• Import DOIs
  • Remove duplicates: DOIs and URLs
  • Validate DOIs
  • store DOIs
  • store OAJ URLs (if not already in the database)
• create DOI URLs
  • new (https)
  • old (dx.doi.org)
  • https landing page (redirect)
  • store URLs
• create unpaywall URLs
  • store URLs
• get NCBI IDs (PMID and PMCID)
  • store PMID and PMCID
  • store URLs

2. Operations: Collect Facebook data: ongoing

• Facebook openGraph Request
  • request
  • store response
• add new dois
  • create DOI URLs
  • create unpaywall URLs
  • get NCBI IDs (PMID and PMCID)
• Priorisierung
• Scheduling

Supportive

• Backup & Restore: Export tables to CSV and import CSV to tables.
  • Backup table
  • Restore table
  • Delete table

Homepage

• add features: import/export, data model, API, requests (NCBI, PMC, Facebook open graph, unpaywall

Contributing Guide

• import/export
• Write tests
• Write/Update code
• Write/Update Docs
• Write/Update Docstrings
• Run pytest
• Run tox
• Run pylint
• Run mypy

4. Evaluate

• Review
  • Code
  • Tests
  • Docs

5. Follow Ups

• [ ]