From 3c413ff5c953fea0e9b31a6753febffa58cbe425 Mon Sep 17 00:00:00 2001 From: ayntk-ai <122374094+ayntk-ai@users.noreply.github.com> Date: Mon, 26 Aug 2024 15:44:30 +0200 Subject: [PATCH] change heading levels --- CONTRIBUTING.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 301f2b124..b8233e2d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,11 +7,11 @@ You can ask for guidance anytime on our [Discord server](https://coollabs.io/dis ## Code Contribution -### 1. Setup your development environment +## 1. Setup your development environment Follow the steps below for your operating system: -#### Windows +### Windows 1. Install Docker Desktop (or similar): - Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/) @@ -20,7 +20,7 @@ Follow the steps below for your operating system: 2. Install Spin: - Follow the instructions to install Spin on Windows from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-windows) -#### MacOS +### MacOS 1. Install Orbstack or Docker Desktop (or similar): - Orbstack (faster, lighter, better alternative to Docker Desktop) @@ -31,7 +31,7 @@ Follow the steps below for your operating system: 2. Install Spin: - Follow the instructions to install Spin on MacOS from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-macos) -#### Linux +### Linux 1. Install Docker Engine or Docker Desktop (or similar): - Docker Engine (recommended): @@ -44,7 +44,7 @@ Follow the steps below for your operating system: --- -### 2. Verify Installation +## 2. Verify Installation After installing Docker (or Orbstack) and Spin, verify the installation: @@ -58,20 +58,20 @@ After installing Docker (or Orbstack) and Spin, verify the installation: --- -### 3. Fork/Clone the Coolify Repository and Setup your Development Environment +## 3. Fork/Clone the Coolify Repository and Setup your Development Environment 1. Fork/clone the [Coolify](https://github.com/coollabsio/coolify) repository to your GitHub account. 2. Install a code editor on your machine (choose one): - Visual Studio Code: - - Windows/macOS/Linux: Download and install from [https://code.visualstudio.com/](https://code.visualstudio.com/) + - Windows/macOS/Linux: Download and install from [https://code.visualstudio.com/download](https://code.visualstudio.com/download) - Cursor (recommended): - Windows/macOS/Linux: Download and install from [https://cursor.sh/](https://cursor.sh/) - Zed (very fast code editor): - - macOS/Linux: Download and install from [https://zed.dev/](https://zed.dev/) + - macOS/Linux: Download and install from [https://zed.dev/download](https://zed.dev/download) - Windows: Not available yet 3. Clone the Coolify Repository to your local machine @@ -83,7 +83,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation: --- -### 4. Set up Environment Variables +## 4. Set up Environment Variables 1. Copy the `.env.development.example` file to your `.env` file. @@ -98,7 +98,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation: --- -### 5. Start & Setup Coolify +## 5. Start & Setup Coolify 1. Open a terminal in the Coolify directory. @@ -115,7 +115,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation: --- -### 6. Start Development +## 6. Start Development 1. Access your Coolify instance: - URL: `http://localhost:8000` @@ -134,7 +134,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation: --- -### 7. Contributing a New Service +## 7. Contributing a New Service To add a new service to Coolify, please refer to our documentation: [Adding a New Service](https://coolify.io/docs/knowledge-base/add-a-service)