BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2025-07-01 15:35:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added Contributing page

Browse Source
This commit is contained in:
Starystars67 2023-10-02 21:59:50 +01:00
parent 313724655c
commit 260f5e57dd
1 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/en/contributing.md
View File

@ -1,13 +1,42 @@
# Contributing to the BeamMP Docs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
BeamMP is using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) as its theme. This is a theme for [MkDocs](https://www.mkdocs.org).
Full documentation can be found at their respective sites.cs.org).
## Commands
## Getting Started
To help contribute to these docs you can take one of two approaches as set out below:
### 1. Edit the raw markdown files
Editing the raw markdown files is the fastest approach and best for quick edits such as spelling, grammar or new snippets of content.
This approach does require a prior knowledge of markdown however as you will need to understand what your contribution will produce.
If this is the approach you wish to take then please follow these steps:
1. Click edit on the page you wish to edit.
2. Fork the project into your own GitHub account.
3. Make the changes you see fit.
4. Commit your changes to your fork.
5. Raise a pull request against our repository [here](https://github.com/BeamMP/Docs).
Once you have created your pull request one of the BeamMP Mod Team will review your Pull Request and either approve it or request some changes.
If changes were requested and you have completed them we will re-review your Pull Request.
Then your changes will be merged into the repository and automatically deployed as part of our continuous integration.
### 2. Make edits with live preview
Editing our docs this way will still take a similar approach as in option 1 however you will be able to preview your changes this way.
1. Click edit on the page you wish to edit.
2. Fork the project into your own GitHub account.
3. Clone the project locally.
4. Setup Material for MkDocs according to their guide [here](https://squidfunk.github.io/mkdocs-material/getting-started/)
5. Run `mkdocs serve` to start the live-reloading docs server from where you cloned the fork to.
6. Make the changes that you see fit.
7. Commit your changes to your fork.
8. Raise a pull request against our repository [here](https://github.com/BeamMP/Docs).
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout