Skip to content

Docs inconsistency fixes #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs inconsistency fixes #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions website/docs/03-other-software/01-prelude.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

**Prelude** is a toolkit designed for the **planning and development stages** of Overture data platform implementation. It helps teams incrementally build and validate platform requirements, enabling them to:

- Systematically verify requirements
- Minimize technical overhead
- Build a foundation for production deployment
- Systematically verify requirements
- Minimize technical overhead
- Build a foundation for production deployment

:::important
Prelude is **not intended for production environments**. It serves as a preparatory tool to ensure successful production deployments. We will be actively improving resources to support teams transitioning from Prelude to production.
Expand Down Expand Up @@ -57,7 +57,7 @@ As summary of command line client interactions is provided in the table below:

### Additional Information

- Relevant API swagger docs can be found from the API dropdown. These swagger APIs are only available when running phases that include the respective service
- Relevant API swagger docs can be found from the API dropdown. These swagger APIs are only available when running phases that include the respective service

## Getting Started

Expand All @@ -75,17 +75,17 @@ cd conductor
Run a pre-deployment check:

```sh
make Phase0
make phase0
```

**Requirements:**

- **Docker Desktop 4.39.0+** with:
- 8-core CPU minimum
- 8 GB memory
- 2 GB swap
- 64 GB virtual disk
- **Node.js 18+ and npm 9+**
- **Docker Desktop 4.39.0+** with:
- 8-core CPU minimum
- 8 GB memory
- 2 GB swap
- 64 GB virtual disk
- **Node.js 18+ and npm 9+**

### 3. Build the local Stage UI image

Expand All @@ -112,7 +112,7 @@ All Prelude documentation is available in the **Documentation** tab here or on o

For assistance, reach out via our [community support channels](https://docs.overture.bio/community/support):

- **Public support:** Use GitHub issues
- **Private inquiries:** Contact us via OICR Slack or [[email protected]](mailto:[email protected])
- **Public support:** Use GitHub issues
- **Private inquiries:** Contact us via OICR Slack or [[email protected]](mailto:[email protected])

We’re actively working on resources to help teams transition to production. If you have suggestions, post them on our [GitHub discussion forum](https://github.com/overture-stack/docs/discussions/categories/ideas).