Verified Commit 94daa80c authored by Caleb Connolly's avatar Caleb Connolly 💬
Browse files

add some initial documentation

parent 610cd2d1
# A SUCS Blog
This blog is designed to be a flat structured site where anyone can write articles on pretty much anything, with a focus on tech and FOSS.
You can find the theme used [here](https://projects.sucs.org/kalube/sucs-hugo-theme)
## How does this work?
The site is written in Hugo, a static site generator, it's designed to be served without needing a webserver/backend
## Status
You can check out the latest testing version of the blog at https://sucs.org/~kalube/blogtest/
CI is currently broken due to some SSH isues, the site will also become available at https://blog.sucs.org once it's ready.
## Feature list
- [X] View posts and tags
- [ ] View authors / have a bio for authors
- [ ] Show latest posts, most popular tags and about section on home page
- [ ] Symposiums - show posts in reply to other posts, current theme etc
\ No newline at end of file
---
title: "S.U.C.S blog"
title: ""
date: 2020-09-22T15:22:12+01:00
comments: false
author: Caleb Connolly
---
asfsfdsfsda
\ No newline at end of file
This blog is designed to be a flat structured site where anyone can write articles on pretty much anything, with a focus on tech and FOSS.
You can find the theme used [here](https://projects.sucs.org/kalube/sucs-hugo-theme) and the source for the site [here](https://projects.sucs.org/kalube/sucs-blog).
Please check out the [/new-authors](/new-authors) guide for instructions on posting to the blog!
\ No newline at end of file
---
title: "Contributing to the blog"
date: 2020-09-22T15:26:45+01:00
comments: false
authors:
- Caleb Connolly
---
How to become an author and contribute your articles
<!--more-->
## Dependencies
You will need git and hugo to contribute, install git using your distributions package manager, windows users go [here](https://git-scm.com/download/win)
```sh
# Ubuntu
sudo apt install git
# Arch
sudo pacman -S git
```
For hugo, check out https://gohugo.io/getting-started/installing/#debian-and-ubuntu
## Getting the source
Clone the source for the blog
```sh
# The theme is installed as a submodule hence recurse-submodules is needed
git clone https://projects.sucs.org/sucs/sucs-blog --recurse-submodules
```
## Add your bio
Create your author and article page, the best way to do that is to copy an existing author and modify
```sh
# Replace firstname/lastname with your name
cp -r content/authors/caleb-connolly content/authors/firstname-lastname
```
Edit content/authors/firstname-lastname/_index.md, write a short bio and fill in your handles
## Getting your change submitted
Checkout a new branch
```sh
git checkout -b add-my-page
```
Commit your changes
```sh
# git status will show you which files changed, make sure you didn't modify any others!
git status
git add * # Will 'stage' your changed to be commited
git commit -m "new-author: Add Bob Bobson as an author"
```
### SUCS members
Push your changes to your own fork of the blog, fortunately you can simply push to a non-existent repo and gitlab will create it for you!
```sh
# change YOUR_USER to be your sucs username
git remote add me https://projects.sucs.org/YOUR_USER/sucs-blog
git push --set-upstream me add-my-page
```
This tells git to push your new branch up to a new repo under your user in gitlab, you can now visit https://projects.sucs.org/YOUR_USER/sucs-blog and use the banner at the top to create a merge request.
### Non-members
As only SUCS members have access to our gitlab, non members will need to email in a patch that we can apply for you.
```sh
# Generate a patch, outputted to the patches folder
git format-patch HEAD~1 -o patches
```
Send en email to staff@sucs.org with the patch as an attachment, someone will review it and apply it for you.
Alternatively you can also use `git send-email`, see this guide for a how-to: https://www.freedesktop.org/wiki/Software/PulseAudio/HowToUseGitSendEmail/
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment