From 1e1b7b36eb11cd8a4c9a531480e1800042e9e27a Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 19 Dec 2024 11:04:43 +0100 Subject: [PATCH] docs: :pencil2: small edits to architecture and naming page (#922) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description This PR is tidying some text up in the landing pages of design and architecture. This PR needs a quick review. --------- Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com> Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com> --- docs/design/architecture/index.qmd | 27 +++++++-------------------- docs/design/architecture/naming.qmd | 2 +- docs/design/index.qmd | 22 ++++++++++++++++++++-- 3 files changed, 28 insertions(+), 23 deletions(-) diff --git a/docs/design/architecture/index.qmd b/docs/design/architecture/index.qmd index 88fa8f081..f79671d93 100644 --- a/docs/design/architecture/index.qmd +++ b/docs/design/architecture/index.qmd @@ -1,16 +1,14 @@ --- -title: "Design of Sprout" +title: "Architecture" --- -This documentation contains the design specific to Sprout, for design -of the Seedcase platform, see the [Design](https://design.seedcase-project.org) -documentation. +This documentation contains the architectural designs that are specific +to Sprout. For design details on Seedcase as a whole, see the +[Design](https://design.seedcase-project.org) documentation. -## Purpose - -The core purpose of writing this architecture documentation is to be -able to describe to ourselves and others what Seedcase Sprout is aiming -to accomplish and how it will do that. +The core purpose of these architectural documents is to be able to +describe to ourselves and others what Seedcase Sprout is aiming to +accomplish and how it will do that. ::: content-hidden ## Technical decisions @@ -19,14 +17,3 @@ to accomplish and how it will do that. showing users and external systems that connect to the Data Resource managed by Seedcase.](images/c4/context.svg) ::: - -## Goals - -Primary **goal** of Sprout are: - -1. **Ingesting data and metadata into standardized storage**: Take - generated data from source locations (such as the clinic or - laboratories) that may be distributed geographically or - organizationally and store it in a secure, centralized location in a - standardized and efficient format to form a Data Resource. Metadata - are similarly stored and linked to the data. diff --git a/docs/design/architecture/naming.qmd b/docs/design/architecture/naming.qmd index 2dea00466..a4f0a03a0 100644 --- a/docs/design/architecture/naming.qmd +++ b/docs/design/architecture/naming.qmd @@ -1,5 +1,5 @@ --- -title: "Naming scheme" +title: "Naming" --- This document describes a general naming scheme for Sprout that is diff --git a/docs/design/index.qmd b/docs/design/index.qmd index ab200dc3e..f1ee6e8f7 100644 --- a/docs/design/index.qmd +++ b/docs/design/index.qmd @@ -1,8 +1,26 @@ --- -title: "Design of Sprout" +title: "Design" --- -Within the design documentation are two main sections: +The core aim of Sprout is to **take data and metadata and convert them +into a standardized and organized storage structure** that follows best +practices for data engineering, particularly with a focus on research contexts. +Specifically, Sprout aims to: + +1. Take generated data from various source locations (such as + clinics or laboratories), which may be distributed geographically or + organizationally, and store it in a standardized and efficient + format. +2. Ensure that metadata is included for the data and organized in a + standardized format, explicitly and programmatically + linking the metadata to the data. + +The purpose of these documents is to describe the overall design of +Sprout in enough detail to help us develop it in a way +that is sustainable (i.e., maintainable over the long term) and that ensures we as a team +have a shared understanding of what Sprout is and is not. + +There are two main sections of this design documentation: - [Architecture](architecture/index.qmd): The architecture section describes the high-level requirements, components, use cases,