Skip to content

Improve documentation #36

@skasberger

Description

@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

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
  1. 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

  • [ ]

Metadata

Metadata

Assignees

Labels

pkg:docsDocumentation related activitiesprio:highstatus:confirmedIs a valid issue and will be moved forward soon.type:featureNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions