55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
---
|
|
sidebar_position: 1
|
|
sidebar_label: Tutorial
|
|
---
|
|
|
|
import TOCInline from '@theme/TOCInline';
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# How to contribute
|
|
|
|
This website is a community project. It is fully open-source with the code being available on [Gitea](pathname://https://git.alexbell.de/aleabodo/survival-pi-docs). It means that every member of the community can edit *anything* of the website and contribute to adding new information and posts to it.
|
|
|
|
## Follow these simple steps to make your first edit
|
|
|
|
### 1. Create a Gitea Account
|
|
Ask the server owner (BuildingBrute) to create an account for you on [Gitea](pathname://https://git.alexbell.de/).
|
|
|
|
### 2. Sign in on Gitea
|
|
Sign in on [Gitea](pathname://https://git.alexbell.de/) with the credentials given to you. Follow the instructions to set a new password.
|
|
|
|
### 3. Fork The Survival-Pi Website.
|
|
*Forking* means copying the code to your own account, so you can edit it. Visit the [repository page](pathname://https://git.alexbell.de/aleabodo/survival-pi-docs/) and click on the `Fork` button on the top-right to create a fork.\
|
|
 \
|
|
Next, click on `Fork Repository` to confirm.\
|
|
 \
|
|
After forking, you will be redirected to your local copy of the website code. You are ready for editing!
|
|
|
|
:::tip[Tip]
|
|
For subsequent edits you can use your forked repository on your profile directly. **You need to create a fork only once with your first edit.**
|
|
:::
|
|
|
|
### 4. Make Your Edit
|
|
Navigate inside `/docs/` to the corresponding page you want to edit. \
|
|
Click the edit button and start editing. \
|
|
|
|
|
|
:::tip[Tip]
|
|
Type `#` to make a headline or `**` to make something bold. Check out [this example page](./example-page.md) or [the markdown cheatsheet](pathname://https://www.markdownguide.org/cheat-sheet/) for more details. If you want to add images send them to the server owner and add the following code to where you want the images to be placed:
|
|
```markdown
|
|
|
|
```
|
|
:::
|
|
|
|
|
|
### 5. Save Your Changes
|
|
Scroll down. \
|
|
Fill out the text field with a meaningful explaination of what you changed. \
|
|
Click on `Commit Changes`. \
|
|
|
|
|
|
### 6. Merge Your Changes Into The Main Repository
|
|
Click `New Pull Request` to request merging your commit into the [main repository](pathname://https://git.alexbell.de/aleabodo/survival-pi-docs/). \
|
|
 \
|
|
The [website](pathname://https://survival-pi.com/) will update with your changes after the server owner accepts your Pull Request. |