Skip to content

Commit

Permalink
docs: ✏️ small edits to architecture and naming page (#922)
Browse files Browse the repository at this point in the history
## Description

This PR is tidying some text up in the landing pages of design and
architecture.

<!-- Select quick/in-depth as necessary -->
This PR needs a quick review.

---------

Co-authored-by: martonvago <[email protected]>
Co-authored-by: Signe Kirk Brødbæk <[email protected]>
  • Loading branch information
3 people authored Dec 19, 2024
1 parent 000f04d commit 1e1b7b3
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 23 deletions.
27 changes: 7 additions & 20 deletions docs/design/architecture/index.qmd
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/design/architecture/naming.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Naming scheme"
title: "Naming"
---

This document describes a general naming scheme for Sprout that is
Expand Down
22 changes: 20 additions & 2 deletions docs/design/index.qmd
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit 1e1b7b3

Please sign in to comment.