Skip to content

Commit 01aaeeb

Browse files
ShadowArcanistShadowArcanist
committed
Added Docs contribution guide
1 parent db2a2c3 commit 01aaeeb

File tree

2 files changed

+161
-37
lines changed

2 files changed

+161
-37
lines changed

‎docs/get-started/contribute/documentation.md‎

Lines changed: 71 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,94 @@
22
title: "Contributing to Coolify Documentation"
33
---
44

5-
# Contribution Guide
5+
# Coolify Docs Contribution Guide
66

7-
Follow these steps to contribute to our documentation:
7+
This guide outlines the process for contributing updates and fixes to our docs. Please follow the steps below to ensure a smooth and efficient workflow.
88

9-
## 1. Fork and Clone the Repository
109

11-
- Fork the documentation repository on GitHub.
12-
- Clone your fork to your local system using:
10+
## 1. Repository Workflow
11+
- **Release Process:**
12+
We follow a weekly production release cycle. The **main** branch represents production, while the **next** branch is used as our development branch.
13+
14+
- **Branching Guidelines:**
15+
- **Do not create pull requests (PRs) to the main branch.**
16+
- All contributions should be made to the **next** branch.
17+
- **Clone the repository from the next branch** to your GitHub account, then start working on your changes.
18+
19+
20+
## 2. Getting Started
21+
22+
### Step 1: Fork and Clone the Repository
23+
- First fork the docs repository to your github account, then clone your fork to your local system using:
1324
```sh
1425
git clone https://github.com/your-username/your-repo-name.git
1526
```
16-
- Navigate to the cloned directory:
27+
- Navigate to the cloned repository:
1728
```sh
1829
cd your-repo-name
1930
```
2031

21-
## 2. Install Dependencies
32+
### Step 2: Install Dependencies and Run the Dev Server
33+
We use [bun](https://bun.sh/) as our preferred package manager for local development. If you choose to use a different package manager, please **do not include its configuration files** in your commit.
2234

23-
Run one of the following commands to install dependencies:
24-
```sh
25-
bun install
26-
# or
27-
npm install
28-
# or
29-
yarn install
30-
# or
31-
pnpm install
32-
```
35+
To set up your environment, run:
36+
```bash
37+
bun install && bun run dev
38+
```
3339

34-
## 3. Start the Development Server
40+
The development server will start on `localhost` at port `5173`. You can view the documentation by navigating to:
41+
```bash
42+
http://localhost:5173/docs/
43+
```
3544

36-
Run one of the following commands to start the development server:
37-
```sh
38-
bun dev
39-
# or
40-
npm run dev
41-
# or
42-
yarn dev
43-
# or
44-
pnpm dev
45+
46+
## 3. Image Guidelines
47+
- **Format:**
48+
All images used in the documentation must be in `.webp` format.
49+
50+
- **Location:**
51+
Place all image files in the `/docs/public` directory.
52+
53+
- **Usage:**
54+
Use the Zoomable image component on the docs to attach your images
55+
```vue
56+
<ZoomableImage src="path-to-the-image.webp" />
4557
```
46-
This will start a local server and provide a URL to preview your changes.
4758

48-
## 4. Make Your Contribution
4959

50-
- Edit an existing markdown file in the `/docs` directory.
51-
- Or create a new `.md` file inside `/docs` or its subdirectories.
60+
## 4. Writing and Structuring Content
61+
62+
### Best Practices for Documentation:
63+
- **Clear and Simple Language:**
64+
Use plain and easily understandable English. Remember that not all readers are native English speakers.
65+
66+
- **Beginner-Friendly Guides:**
67+
Break down instructions into small, easy-to-follow steps. Include screenshots wherever possible to help visualize the process, especially for users new to self-hosting or Coolify.
68+
69+
- **Content Organization:**
70+
Structure your content with clear headings, bullet points, and numbered steps where applicable. This makes it easier for readers to follow along.
71+
72+
73+
## 5. Submitting Your Contribution
74+
1. **Commit your changes to your repository**
75+
76+
2. **Create a Pull Request:**
77+
- Open a pull request (PR) to merge your changes into the **next** branch on the docs repository.
78+
- Provide a detailed description of your updates to help maintainers review your contribution effectively.
79+
80+
81+
## 6. Questions and Support
82+
If you have any questions or run into issues while contributing:
83+
- **Create an Issue:** Open an issue on the repository detailing your issue.
84+
- **Discord:** Reach out to us on contribute channel on the Coolify Discord community.
85+
5286

53-
## 5. Submit a Pull Request
87+
## 7. Important Notes
88+
- **Documentation Updates:**
89+
The current docs are bit outdated and missing some information. The docs maintainers are actively rewriting parts of the documentation to improve structure and clarity before new content is added.
5490

55-
- Push your changes to your forked repository.
56-
- Create a pull request to merge your changes into the main documentation repository.
91+
- **PR Approval:**
92+
Merging of your PR is subject to review by the maintainers. Please be patient as they work through the process.
5793

58-
Thank you for contributing!
5994

95+
We appreciate your contribution and effort in making the Coolify docs better for everyone.

‎readme.md‎

Lines changed: 90 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,93 @@
11
# Coolify Documentation
22
This is the official repository for Coolify documentation, available at https://coolify.io/docs
33

4-
## Contributing
5-
Contributors should follow the guide at: https://coolify.io/docs/resource/contribute/documentation
4+
5+
## Contribution Guide
6+
This guide outlines the process for contributing updates and fixes to our docs. Please follow the steps below to ensure a smooth and efficient workflow.
7+
8+
## 1. Repository Workflow
9+
- **Release Process:**
10+
We follow a weekly production release cycle. The **main** branch represents production, while the **next** branch is used as our development branch.
11+
12+
- **Branching Guidelines:**
13+
- **Do not create pull requests (PRs) to the main branch.**
14+
- All contributions should be made to the **next** branch.
15+
- **Clone the repository from the next branch** to your GitHub account, then start working on your changes.
16+
17+
18+
## 2. Getting Started
19+
20+
### Step 1: Fork and Clone the Repository
21+
- First fork the docs repository to your github account, then clone your fork to your local system using:
22+
```sh
23+
git clone https://github.com/your-username/your-repo-name.git
24+
```
25+
- Navigate to the cloned repository:
26+
```sh
27+
cd your-repo-name
28+
```
29+
30+
### Step 2: Install Dependencies and Run the Dev Server
31+
We use [bun](https://bun.sh/) as our preferred package manager for local development. If you choose to use a different package manager, please **do not include its configuration files** in your commit.
32+
33+
To set up your environment, run:
34+
```bash
35+
bun install && bun run dev
36+
```
37+
38+
The development server will start on `localhost` at port `5173`. You can view the documentation by navigating to:
39+
```bash
40+
http://localhost:5173/docs/
41+
```
42+
43+
44+
## 3. Image Guidelines
45+
- **Format:**
46+
All images used in the documentation must be in `.webp` format.
47+
48+
- **Location:**
49+
Place all image files in the `/docs/public` directory.
50+
51+
- **Usage:**
52+
Use the Zoomable image component on the docs to attach your images
53+
```vue
54+
<ZoomableImage src="path-to-the-image.webp" />
55+
```
56+
57+
58+
## 4. Writing and Structuring Content
59+
60+
### Best Practices for Documentation:
61+
- **Clear and Simple Language:**
62+
Use plain and easily understandable English. Remember that not all readers are native English speakers.
63+
64+
- **Beginner-Friendly Guides:**
65+
Break down instructions into small, easy-to-follow steps. Include screenshots wherever possible to help visualize the process, especially for users new to self-hosting or Coolify.
66+
67+
- **Content Organization:**
68+
Structure your content with clear headings, bullet points, and numbered steps where applicable. This makes it easier for readers to follow along.
69+
70+
71+
## 5. Submitting Your Contribution
72+
1. **Commit your changes to your repository**
73+
74+
2. **Create a Pull Request:**
75+
- Open a pull request (PR) to merge your changes into the **next** branch on the docs repository.
76+
- Provide a detailed description of your updates to help maintainers review your contribution effectively.
77+
78+
79+
## 6. Questions and Support
80+
If you have any questions or run into issues while contributing:
81+
- **Create an Issue:** Open an issue on the repository detailing your issue.
82+
- **Discord:** Reach out to us on contribute channel on the Coolify Discord community.
83+
84+
85+
## 7. Important Notes
86+
- **Documentation Updates:**
87+
The current docs are bit outdated and missing some information. The docs maintainers are actively rewriting parts of the documentation to improve structure and clarity before new content is added.
88+
89+
- **PR Approval:**
90+
Merging of your PR is subject to review by the maintainers. Please be patient as they work through the process.
91+
92+
93+
We appreciate your contribution and effort in making the Coolify docs better for everyone.

0 commit comments

Comments
 (0)