Skip to content

Write design document draft #1

Description

@uniqueg

The initial draft, to be committed in this repo, should contain the following

  • The version of the document in SemVer style, starting with v0.1.0
  • A *mission statement outlining the vision underlying the Krini suite of services and components
  • A high level description of the design principles for the Krini project
  • A section detailing the requirements and recommendations with regard to the tech/tool stack that associated services MUST or SHOULD conform to
  • A section on security and AAI-related guidelines (with linkouts to the relevant guidelines by ELIXIR Cloud & AAI and GA4GH)
  • A section on use cases, outlining in some detail the first/primary use case: the leveraging of the GA4GH Cloud API suite (with its current limitations); at the very least, the required services and components should be outlined so that the corresponding repositories can be set up under this organization; enough detail should further be included to allow the posting of detailed issues
  • A technical glossary
  • A contributing section with information on how people can get involved
  • Information about the organizational structure of the project (ELIXIR Cloud & AAI, ELIXIR) and its relation to GA4GH
  • Contact information

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions