Skip to content

Rewrite documentation website content for RO-Crate Validation Service 2.0 #296

Description

@alexhambley

Issue

The docs need to be rewritten for the 2.0 release and ENTRUST deliverable.

Per page:

  • index.md - service overview, validation modes, links to the other pages
  • installation.md - quick start guide, enabling object storage, config reference
  • upgrading.md - 1.* → 2.0 migration: settings, API changes, upgrades
  • api.md - API endpoint reference for 2.0
  • five-safes.md - validating Five Safes RO-Crates in a TRE (& renameentrust.md; closes ESG: WorkflowHub upload drive #122)
  • contribution.md - development setup, tests, architecture overview
  • mkdocs.yml - nav entries for the new pages, site name

Related:

eScienceLab/RO-Crate-Validation-Service#122,
eScienceLab/RO-Crate-Validation-Service#151.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions