Improvements to the doc (#1989)

* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup

* removed package-lock.json

* added doc card, admonitions

* removed underline from nav buttons
This commit is contained in:
Nimra Ahmed
2023-10-13 12:13:13 +05:00
committed by GitHub
parent 4e993316a6
commit 13db1bd0a6
21 changed files with 92 additions and 13665 deletions
@@ -1,6 +1,7 @@
---
title: Docker Setup
sidebar_position: 2
description: Set up the project with Docker.
sidebar_custom_props:
icon: TbBrandDocker
---
@@ -46,7 +47,11 @@ PG_DATABASE_URL=postgres://twenty:twenty@postgres:5432/default?connection_limit=
We provide an environment containerized with Docker and orchestrated with `docker-compose`.
This installation method will also provision a PostgreSQL container.
> **Note:** The configuration for the build is stored in the `infra/dev` folder, but you can run `make` commands directly from the root folder.
:::info
The configuration for the build is stored in the `infra/dev` folder, but you can run `make` commands directly from the root folder.
:::
```bash
make build