godotengine/godot-website
1
0
Fork 0
mirror of https://github.com/godotengine/godot-website.git synced 2026-09-03 23:34:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #404 from YuriSizov/readme-improve-docker-guide

Browse Source 
Improve contribution and docker instructions
This commit is contained in:
Yuri Sizov
2022-07-11 23:14:43 +03:00
committed by GitHub
parent 6931563dd2 893a3e2aa7
commit 8f6d4b6764
3 changed files with 116 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -1,6 +1,7 @@
# Exclude everything by default (this is a CMS!), and whitelist the safe stuff # Exclude everything by default (this is a CMS!), and whitelist the safe stuff
/* /*
!/README.md !/README.md
!/DEVELOPMENT_SETUP.md
!/ISSUE_TEMPLATE.md !/ISSUE_TEMPLATE.md
!/LICENSE.txt !/LICENSE.txt

93
DEVELOPMENT_SETUP.md Normal file
View File

@@ -0,0 +1,93 @@
# Local development setup
The provided Docker setup takes care of installing all the necessary
dependencies so you don't have to.
## Automatic Docker setup
Clone this repository, and then follow the steps described below:
### 0. Prepare the database dump.
**You don't need a database dump to contribute, just skip to step 1.**
If you have a database dump, put it into the `./docker/mariadb/init` folder.
- Make sure that your script starts with the line `USE october;` and that the
file extension is `.sql`.
- Every `.sql` and `.sh` file from the `./docker/mariadb/init` folder will be
automatically executed when building the container.
### 1. Open the `./docker` folder.
Using a terminal, or another command-line environment, navigate to the `./docker`
folder.
```sh
# Assuming you're in the project root.
cd ./docker
```
### 2. Run the Docker compose command.
Execute the following command:
```sh
docker-compose -p "godot-website" up --build -d --force-recreate
```
- You can replace `"godot-website"` with anything else to help you identify this
project in your Docker manager.
- In the future, you can use the `./docker/restart.sh` script to rebuild containers
(Linux and macOS only).
The script will take **a couple of minutes** to run the first time. After the
build is done, the containers will automatically start and perform their first
time setup. Check the logs of the `godotengine-org--php` container, as it takes
more time to finish. You will see the following line in the logs when it's done:
> Godot Website is READY to use!
### 3. Open the website in a browser!
You can see the website at [http://localhost:8080](http://localhost:8080).
- The control panel is located at [http://localhost:8080/backend](http://localhost:8080/backend).
- The default admin account is `admin/admin`.
You can now start contributing and changing files in `./themes/godotengine`.
Changes should be visible in real time, without a need to restart the web server.
## Interfacing with Docker containers
You can use the standard syntax to either execute a shell command or connect
to the running container:
```sh
# Execute shell command.
docker exec -it godotengine-org--[php|mariadb] [command]
# Connect to a remote shell.
docker exec -it godotengine-org--[php|mariadb] /bin/bash
```
There are several shell scripts that come with the project, that may be useful
when developing (assuming you're running Linux or macOS).
- For the web server:
- `./docker/php/bash.sh` starts a bash session with the PHP container.
- `./docker/php/install-plugin.sh` is used to install additional CMS plugins with `artisan`.
- `./docker/php/log.sh` is used to access logs of the PHP container.
- For the database server:
- `./docker/mariadb/bash.sh` starts a bash session with the MariaDB container.
- `./docker/mariadb/log.sh` is used to access logs of the MariaDB container.
- `./docker/mariadb/mysql.sh` starts a MySQL shell session in the MariaDB container.
## Manual setup
If you would rather configure your own development environment, you
can investigate the follow files to replicate the required steps:
- `./docker/docker-compose.yml`
- `./docker/mariadb/init/000-setup.sql`
- `./docker/php/Dockerfile`
- `./docker/php/init/init.sh`

79
README.md
View File

@@ -4,8 +4,10 @@ This repository contains the theme used by the Godot Engine's OctoberCMS/WinterC
instance. The theme describes both the styling of the website and the components instance. The theme describes both the styling of the website and the components
of its layouts, as well as some of its content. of its layouts, as well as some of its content.
- [OctoberCMS](https://github.com/octobercms/october) is the original CMS platform of choice. - [OctoberCMS](https://github.com/octobercms/october) is the original CMS platform
- [WinterCMS](https://github.com/wintercms/winter) is the current CMS platform, a fork of October with more active development. of choice.
- [WinterCMS](https://github.com/wintercms/winter) is the current CMS platform, a fork
of October with more active development.
_WinterCMS_ is compatible with _OctoberCMS_, and uses the same plugin system. This is _WinterCMS_ is compatible with _OctoberCMS_, and uses the same plugin system. This is
at least true for the version of the project that we use. at least true for the version of the project that we use.
@@ -15,6 +17,15 @@ is not used for production.
## Contributing ## Contributing
Contributions are always welcome! Godot website, just like Godot engine, is open source.
However, when contributing to the website, it is important to keep in mind that it
acts as a public face of Godot organization and community. Thus, substantial
changes must be discussed ahead of time. You don't necessarily need to open a formal
Godot improvement proposal like you do with engine features, but starting an issue
on this repository or joining the discussion on the
[Godot Contributors Chat](https://chat.godotengine.org/channel/website) is a good idea.
### Browser support ### Browser support
When working on new features, keep in mind this website only supports When working on new features, keep in mind this website only supports
@@ -26,7 +37,7 @@ _evergreen browsers_:
- Opera (latest version and N-1 version) - Opera (latest version and N-1 version)
- Safari (latest version and N-1 version) - Safari (latest version and N-1 version)
Internet Explorer isn't supported. **Internet Explorer isn't supported.**
### Dependencies ### Dependencies
@@ -38,63 +49,17 @@ This project requires the following stack:
There are also some linting tools that can be run locally that require Node.js. There are also some linting tools that can be run locally that require Node.js.
### Local development setup
This project comes with a [Docker](https://docker.com) setup that can be used to quickly This project comes with a [Docker](https://docker.com) setup that can be used to quickly
create a network of compatible containers. Using this setup, you can have a local copy of create a network of compatible ready-to-use containers.
the project, without the production database. For development purposes, you don't need
that database, as the only thing that is specific to production is blog posts, which can
be easily recreated if required.
### Local setup Using this setup, you can have a local copy of the project, without the production database.
For development purposes, you don't need that database, as the only thing that is specific
to production is blog posts, which can be easily recreated if required. Everything else
is located in the `./themes/godotengine` folder, including all static pages and their content.
While it is possible to configure a local environment manually, To start contributing, please follow this [Local development setup](DEVELOPMENT_SETUP.md) guide.
we recommend using the provided Docker setup.
- Clone this repository.
- If you have a database dump, put it into the `./docker/mariadb/init` folder.
- Make sure that your script starts with the line `USE october;` and that the file extension is `.sql`.
- Every `.sql` and `.sh` file from that directory will be automatically executed when building the container.
- Using a terminal, or another command-line environment, go to the `./docker` folder and execute the following command.
- You can replace `"godot-website"` with anything else to help you identify this project in your Docker manager.
- In the future, you can use the `./docker/restart.sh` script to rebuild containers.
```
docker-compose -p "godot-website" up --build -d --force-recreate
```
The script will take a couple of minutes to run the first time. After the
build is done, the containers will automatically start and perform their
first time setup. Check the logs of the `godotengine-org--php` container,
as it takes more time to finish. You will see the following line in the
logs when it's done:
> Godot Website is READY to use!
See the website at [http://localhost:8080](http://localhost:8080). The control
panel is located at [http://localhost:8080/backend](http://localhost:8080/backend).
The default admin account is `admin/admin`.
### Interfacing with Docker containers
You can use the standard syntax to either execute a shell script or connect
to the running container:
```
# Execute shell command.
docker exec -it godotengine-org--[php|mariadb] [command]
# Connect to a remote shell.
docker exec -it godotengine-org--[php|mariadb] /bin/bash
```
There are several shell scripts that come with the project, that may be useful
when developing (assuming you're running Linux or macOS):
- `./docker/php/bash.sh` starts a bash session with the PHP container.
- `./docker/php/install-plugin.sh` is used to install additional CMS plugins with `artisan`.
- `./docker/php/log.sh` is used to access logs of the PHP container.
- `./docker/mariadb/bash.sh` starts a bash session with the MariaDB container.
- `./docker/mariadb/log.sh` is used to access logs of the MariaDB container.
- `./docker/mariadb/mysql.sh` starts a MySQL shell session in the MariaDB container.
### Syntax highlighting ### Syntax highlighting