2.7 KiB

sidebar_position, sidebar_label
sidebar_position sidebar_label
1 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. 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.

2. Sign in on Gitea

Sign in on Gitea 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 and click on the Fork button on the top-right to create a fork.
Fork
Next, click on Fork Repository to confirm.
alt text
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.
Edit

:::tip[Tip] Type # to make a headline or ** to make something bold. Check out this example page or the markdown cheatsheet 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 ![Pic](/img/placeholder.jpg) :::

5. Save Your Changes

Scroll down.
Fill out the text field with a meaningful explaination of what you changed.
Click on Commit Changes.
Commit

6. Merge Your Changes Into The Main Repository

Click New Pull Request to request merging your commit into the main repository.
Pullrequest
The website will update with your changes after the server owner accepts your Pull Request.