cccb-website-team/www
1
1
Fork 1
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

update README.md

Browse source
This commit is contained in:
Vinzenz Schroeter 2025-03-09 14:07:37 +01:00
parent 77cc995c03
commit e10cfcdbcc
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,23 +1,19 @@
![CCCB logo](static/img/logo.png)
# CCCB Website # CCCB Website
This is the website of the CCCB. This is the website of the CCCB.
![CCCB logo](assets/img/logo.png)
## Getting started ## Getting started
1. Get Hugo: <https://gohugo.io/getting-started/installing> 1. Get Hugo: <https://gohugo.io/getting-started/installing>
2. Clone this repo 2. Clone this repo (`--recursive` is needed to check out submodules)
```shell ```shell
git clone https://github.com/cccb/www git clone --recursive https://git.berlin.ccc.de/cccb-website-team/www.git cccb-website
``` ```
3. Switch directory 3. Switch directory
```shell ```shell
cd www cd cccb-website
```
3. Fetch Submodules
```shell
git submodule update --recursive --remote --init
``` ```
### Run site locally ### Run site locally
@ -35,13 +31,13 @@ Every change you make on the project will be reflected in your browser as long a
## Making a change ## Making a change
1. Use your local dev setup (see Getting started) or via GitHub editor. 1. Use your local dev setup (see Getting started) or via the Forgejo editor.
2. Make your change in `staging` branch. 2. Make your change in `staging` branch.
3. Commit (and push) your change. 3. Commit (and push) your change.
4. GitHub Actions is running the release workflow. 4. ~~GitHub Actions is running the release workflow.~~
- If successful, check [Staging Website](https://staging.berlin.ccc.de/) if change is correct. - If successful, check [Staging Website](https://staging.berlin.ccc.de/) if change is correct.
5. Create merge request to merge changes from `staging` to `production` branch. Ask somebody to check merge request or if small change, merge yourself. 5. Create merge request to merge changes from `staging` to `production` branch. Ask somebody to check merge request or if small change, merge yourself.
6. GitHub Actions is running the release workflow. 6. ~~GitHub Actions is running the release workflow.~~
- If successfull, check [Website](https://berlin.ccc.de/) if change is correct. - If successfull, check [Website](https://berlin.ccc.de/) if change is correct.
7. Profit! 7. Profit!