|
1 |
| -How to contribute |
2 |
| -================= |
3 |
| - |
4 |
| -Want to develop or contribute to this project? |
5 |
| -Contributions and improvements are appreciated and welcome. |
6 |
| -This guide explains how to set up a development environment and make a contribution. |
7 |
| - |
8 |
| - |
9 |
| -## Create a development environment |
10 |
| - |
11 |
| -This project uses a [**Docker**](https://en.wikipedia.org/wiki/Docker_%28software%29) container to create a development environment. |
12 |
| -This solution works with Docker on Linux, macOS, and Windows. |
13 |
| -We use Docker to run a container to build and serve the website. |
14 |
| -Then, when you make changes, they are reflected immediately in your running copy of the site when you press "Save". |
15 |
| - |
16 |
| -### Pre-requisites |
17 |
| - |
18 |
| -Install Docker: |
19 |
| - |
20 |
| -* Linux |
21 |
| - * [Fedora](https://developer.fedoraproject.org/tools/docker/docker-installation.html) |
22 |
| - * [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/) |
23 |
| -* [macOS](https://docs.docker.com/docker-for-mac/install/) |
24 |
| -* [Windows](https://docs.docker.com/toolbox/overview/) |
25 |
| - |
26 |
| -### Run development script |
27 |
| - |
28 |
| -In a new window, run the [`start_devel_env.sh`](https://github.com/FOSSRIT/fossrit.github.io/blob/master/start_devel_env.sh) script. |
29 |
| -This script downloads a Jekyll Docker container and builds the website. |
30 |
| -Once it starts, you can access a local version of the website by visiting this URL: |
31 |
| - |
32 |
| -``` |
33 |
| -http://localhost:4000 |
34 |
| -``` |
35 |
| - |
36 |
| -## Submitting contributions |
37 |
| - |
38 |
| -More detailed steps will be documented in the future. |
39 |
| -For now, if you want to contribute, submit a new pull request. |
| 1 | +See the [_Website (fossrit.github.io)_](https://runbook.fossrit.community/infra/website/ "Website (fossrit.github.io) - FOSSRIT Runbook") page in the [FOSSRIT Runbook](https://runbook.fossrit.community/). |
0 commit comments