Skip to content

Commit 5a22958

Browse files
updated images
1 parent 9f53552 commit 5a22958

File tree

15 files changed

+27
-20
lines changed

15 files changed

+27
-20
lines changed

submodules/stage

website/docs/01-core-software/01-core-software.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ import Tabs from '@theme/Tabs';
44
import TabItem from '@theme/TabItem';
55
import DocCardList from '@theme/DocCardList';
66

7-
Our core software documentation is organized to provide you with a clear and logical path through each service:
7+
![Core Software](./images/core-software.webp 'Core Software')
8+
9+
Our core software documentation is organized as follows:
810

911
```
1012
.
1.3 MB
Loading

website/guides/00-getting-started.mdx

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@ import DocCardList from '@theme/DocCardList';
22

33
# Getting Started
44

5-
Welcome to the Overture platform guides. Here you'll find comprehensive information on deploying and using Overture microservices as an integrated platform.
6-
7-
Our guides currently cover the following key areas:
5+
Welcome to the Overture platform guides. Here you'll find comprehensive information on deploying and using Overture microservices as an integrated platform. Our guides currently cover the following key areas:
86

97
<DocCardList items={[
108

@@ -39,7 +37,9 @@ Our guides currently cover the following key areas:
3937
If you can't find what you're looking for please reach out to us on our Slack channel linked on the top right of your screen or by email at contact@overture.bio
4038
:::
4139

42-
## Quick Start Guide
40+
## Overture Platform Quick Start
41+
42+
![Overture Platform Quickstart](./images/core-software.webp 'Overture Platform Quickstart')
4343

4444
For a rapid, hassle-free setup of the Overture data platform on your local machine, follow these steps:
4545

@@ -64,11 +64,14 @@ For a rapid, hassle-free setup of the Overture data platform on your local machi
6464

6565
3. **Launch the Platform:** Run the appropriate command for your operating system:
6666

67-
| OS | Command |
68-
|----|---------|
69-
| Unix/macOS | `make platform` |
70-
| Windows | `make.bat platform` |
7167

72-
This will deploy the following services in Docker:
68+
- For Unix/macOS run `make platform`
69+
- For Windows run`make.bat platform`
70+
71+
This will deploy the following services in Docker:
72+
73+
![Overture Platform Architecture](./images/platform.svg 'Overture Platform')
7374

74-
![Overture Platform Architecture](./images/platform.svg 'Overture Platform')
75+
:::info Get Started with Our Platform Guides
76+
Check out our [**administration**](/guides/administration-guides/) and [**user guides**](/guides/user-guides/) for detailed guidance on using the platform.
77+
:::

website/guides/03-user-guides/01-cli-submissions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# CLI Submission
22

3-
- **This guide is for** anyone seeking guidance on submitting data to an Overture platform. By the end of this guide you will have completed a full data submission workflow, including updating the submitted data to conform to the data model enforced by Song.
3+
**This guide is for** anyone seeking guidance on submitting data to an Overture platform. By the end of this guide you will have completed a full data submission workflow, including updating the submitted data to conform to the data model enforced by Song.
44

5-
- **You will need** docker installed. We recommend using Docker Desktop; for more information, visit [Dockers website](https://www.docker.com/products/docker-desktop/)
5+
**You will need** docker installed. We recommend using Docker Desktop; for more information, visit [Dockers website](https://www.docker.com/products/docker-desktop/)
66

7-
- **Background:** Submitting data to an Overture platform typically includes data files (BAMS, CRAMS, VCFs, etc.) along with associated metadata that provides context including donor information and descriptions of the data files. This guide focuses on submitting data to Song & Score using their Command Line Clients (CLIs).
7+
**Background:** Submitting data to an Overture platform typically includes data files (BAMS, CRAMS, VCFs, etc.) along with associated metadata that provides context including donor information and descriptions of the data files. This guide focuses on submitting data to Song & Score using their Command Line Clients (CLIs).
88

9-
![Submission Overview](../images/submissionOverview.webp 'End Goal')
9+
#### Visual Summary:
1010

11-
The Song and Score clients work together to upload raw data files to object storage and track all related metadata stored in the Song metadata repository.
11+
![Submission Overview](../images/dataSubmission.webp 'End Goal')
1212

1313
### Getting Started
1414

website/guides/03-user-guides/02-cli-downloads.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# CLI Downloads
22

3-
- **This guide is for** anyone seeking guidance on how to download data from an Overture platform.
3+
**This guide is for** anyone seeking guidance on how to download data from an Overture platform.
44

5-
- **You will need** docker installed. We recommend using Docker Desktop; for more information, visit [Dockers website](https://www.docker.com/products/docker-desktop/)
5+
**You will need** docker installed. We recommend using Docker Desktop; for more information, visit [Dockers website](https://www.docker.com/products/docker-desktop/)
66

7-
![Retrieval Overview](../images/dataRetrieval.png 'End Goal')
7+
#### Visual Summary:
8+
9+
![Retrieval Overview](../images/dataRetrieval.webp 'End Goal')
810

911
## Getting Started
1012

website/guides/images/apikeys.png

243 KB
Loading
377 KB
Loading
1.3 MB
Loading
-9.67 MB
Binary file not shown.

0 commit comments

Comments
 (0)