From 3602d345ca54652255da7a0d590bc1a87a9b66bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Poign=C3=A9e=5Fde=5Fporte?= Date: Wed, 6 Aug 2025 20:14:40 +0000 Subject: [PATCH 1/4] Translate contributing.md via GitLocalize --- docs/fr/contributing.md | 43 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/fr/contributing.md diff --git a/docs/fr/contributing.md b/docs/fr/contributing.md new file mode 100644 index 00000000..08135d65 --- /dev/null +++ b/docs/fr/contributing.md @@ -0,0 +1,43 @@ +# Contribuer à la documentation de BeamMP + +BeamMP utilise [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) pour son thème. C'est un thème pour [MkDocs](https://www.mkdocs.org). Les documentations peuvent être retrouvées sur leurs site web respectifs. + +## Pour commencer + +Vous pouvez utiliser une des deux méthodes ci-dessous pour contribuer à la documentation: + +### 1. Modifiez directement les fichiers markdown + +Modifier directement les fichiers markdown est la façon la plus rapide pour les petites modifications tel que les erreurs de frappes, erreurs de grammaires ou les petits ajouts de contenus. Cette approche nécessite une compréhension des fichiers markdown puisque vous devez comprendre les changement que vos modifications vont produire. + +Si vous décider d'utiliser cette méthode, veuillez suivre ces étapes: + +1. Cliquez sur edit sur la page que vous souhaitez modifier. +2. Faites une fork du projet et intégrez le à votre propre compte GitHub. +3. Faites les modifications que vous pensez nécessaires. +4. Vérifiez les modifications que votre fork apporte. +5. Faite une requête de pour intégrer vos changement à notre répertoire [ici](https://github.com/BeamMP/Docs). + +Une fois que vous avez fait votre demande d'intégration, une personne de l'équipe de modération de BeamMP va réviser vos modifications et va, soit approuver les changements, soit demander de faire des modifications nécessaires. Si des modifications ont été demandées et que vous les avez effectuées nous allons réévaluer votre requête d'intégration. Les modifications que vous avez apporter seront ensuite appliquées automatiquement due à notre intégration continue. + +### 2. Faire des modifications avec un aperçu en direct + +Modifier notre documentation de cette façon ressemble à l'option 1, cependant, vous allez pouvoir apercevoir vos changements en direct. + +1. Cliquez sur edit sur la page que vous souhaitez modifier. +2. Faites une fork du projet et intégrez le à votre propre compte GitHub. +3. Faite une copie local du projet. +4. Configurez: «Material for MkDocs» en suivant leur guide [ici](https://squidfunk.github.io/mkdocs-material/getting-started/) +5. Exécutez `mkdocs serve` pour démarrer le serveur de documentation de rechargement en direct à partir duquel vous avez cloné le fork. +6. Faites les modifications que vous pensez nécessaires. +7. Vérifiez les modifications que votre fork apporte. +8. Faite une requête de pour intégrer vos changement à notre répertoire [here](https://github.com/BeamMP/Docs). + +## Présentation du projet + +``` +mkdocs.yml # The configuration file. +docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. +``` From 9581d14f7fc68694f30d1d59546eae4ebbf54976 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Thu, 7 Aug 2025 07:26:41 +0200 Subject: [PATCH 2/4] Update rules.md Rule changes suggestion. Requires PRM approval. --- docs/en/community/rules.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/en/community/rules.md b/docs/en/community/rules.md index 4397af93..9013b461 100644 --- a/docs/en/community/rules.md +++ b/docs/en/community/rules.md @@ -28,14 +28,19 @@ hide: ## Discord Rules -1. All Above Rules Apply Here :material-information-outline:{ title="All rules mentioned in this document apply to the voice chats." } -2. Follow Discord ToS & Guidelines :material-information-outline:{ title="Follow all rules outlined by Discord in their ToS and Guidelines" } -3. No NSFW Audio/Streams :material-information-outline:{ title="Players should not stream any content that violates BeamMP rules stated in Section 1 of this document." } -4. No Excessive Audio :material-information-outline:{ title="The excessive use of soundboards, playing music loudly or other uses of audio channels to intentionally agitate or target others is not allowed." } -5. No Join/Leave Spamming :material-information-outline:{ title="Most users will have sound effects enabled, do not join and leave chats rapidly." } -6. No Badgering Others (`@'ing`) :material-information-outline:{ title="This includes asking others repeatedly for a response after being ignored or told no." } -7. Keep bot commands in command specific channels -8. No Role-Playing :material-information-outline:{ title="This is in place to prevent issues arising due to missing context or to prevent users from circumventing certain rules." } +1. All Above Rules Apply Here :material-information-outline:{ title="All rules mentioned in this document apply to the voice chats." } +2. Follow Discord ToS & Guidelines :material-information-outline:{ title="Follow all rules outlined by Discord in their ToS and Guidelines" } +3. No NSFW Audio/Streams :material-information-outline:{ title="Players should not stream any content that violates BeamMP rules stated in Section 1 of this document." } +3.1. This includes gambling Services/Websites. +5. No Excessive Audio :material-information-outline:{ title="Excessively using soundboards, playing loudl music or other uses of audio channels to intentionally agitate or target others is prohibited." } +6. No Join/Leave Spamming :material-information-outline:{ title="Most users will have sound effects enabled, do not join and leave voice-chats rapidly." } +7. No Badgering Others (`@'ing`) :material-information-outline:{ title="This includes asking others repeatedly for a response after being ignored or told no." } +8. Keep bot commands in command specific channels. +10. No Role-Playing :material-information-outline:{ title="This is in place to prevent issues arising due to missing context or to prevent users from circumventing certain rules." } +11. Do not offer to remote into other users computers or send malicous files. +12. Do not explain/send links on how to pirate, acquire illegal copies of software, hacking accounts (Beaming), or paid mods. +13. Do not advertise non-BeamNG/BeamMP content. Sending Media of your own channel is only allowed in the dedicated [media channel](https://discord.com/channels/601558901657305098/705427325646274680). +14. Follow the instructions of Staff members. If you think a staff member is abusing their power, direct message their lead or project management. ## How to appeal actions against you: @@ -44,4 +49,4 @@ hide: All ban appeals are investigated thoroughly, involving at least two (2) members of the staff/moderation team that were not involved in the case-at-hand. The issuing staff member will be allowed to comment, but will not be otherwise involved in the appeal decision. These appeal outcomes are final. BeamMP reserves the right to allow or not allow members as they deem appropriate according to the BeamMP Community Rules (as above), [Discord ToS](https://discord.com/terms), and other factors. !!! warning - In the event of action taken against you, you are prohibited from creating a new Discord or BeamMP account to circumvent the ban. \ No newline at end of file + In the event of action taken against you, you are prohibited from creating a new Discord or BeamMP account to circumvent the ban. From 991b2f4bb745c9e4190c013fafa28695c02cd766 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Sat, 9 Aug 2025 20:17:47 +0200 Subject: [PATCH 3/4] Update rules.md fixes --- docs/en/community/rules.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/community/rules.md b/docs/en/community/rules.md index 9013b461..79c41db5 100644 --- a/docs/en/community/rules.md +++ b/docs/en/community/rules.md @@ -30,9 +30,9 @@ hide: 1. All Above Rules Apply Here :material-information-outline:{ title="All rules mentioned in this document apply to the voice chats." } 2. Follow Discord ToS & Guidelines :material-information-outline:{ title="Follow all rules outlined by Discord in their ToS and Guidelines" } -3. No NSFW Audio/Streams :material-information-outline:{ title="Players should not stream any content that violates BeamMP rules stated in Section 1 of this document." } +3. No NSFW Audio/Streams :material-information-outline:{ title="Players should not stream any content that violates BeamMP rules and Discord TOS." } 3.1. This includes gambling Services/Websites. -5. No Excessive Audio :material-information-outline:{ title="Excessively using soundboards, playing loudl music or other uses of audio channels to intentionally agitate or target others is prohibited." } +5. No Excessive Audio :material-information-outline:{ title="Excessively using soundboards, playing loud music or other uses of audio channels to intentionally agitate or target others is prohibited." } 6. No Join/Leave Spamming :material-information-outline:{ title="Most users will have sound effects enabled, do not join and leave voice-chats rapidly." } 7. No Badgering Others (`@'ing`) :material-information-outline:{ title="This includes asking others repeatedly for a response after being ignored or told no." } 8. Keep bot commands in command specific channels. From 9a70e3b03cc2af8f467525612e853d5c80d1c010 Mon Sep 17 00:00:00 2001 From: Protogen187 <162638343+Protogen187@users.noreply.github.com> Date: Tue, 12 Aug 2025 19:25:33 +0200 Subject: [PATCH 4/4] Update rules.md Change numbering so "3.1" becomes "4" and has it's own line as intented --- docs/en/community/rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/community/rules.md b/docs/en/community/rules.md index 79c41db5..32fe2540 100644 --- a/docs/en/community/rules.md +++ b/docs/en/community/rules.md @@ -31,7 +31,7 @@ hide: 1. All Above Rules Apply Here :material-information-outline:{ title="All rules mentioned in this document apply to the voice chats." } 2. Follow Discord ToS & Guidelines :material-information-outline:{ title="Follow all rules outlined by Discord in their ToS and Guidelines" } 3. No NSFW Audio/Streams :material-information-outline:{ title="Players should not stream any content that violates BeamMP rules and Discord TOS." } -3.1. This includes gambling Services/Websites. +4. The rule above includes gambling Services/Websites. 5. No Excessive Audio :material-information-outline:{ title="Excessively using soundboards, playing loud music or other uses of audio channels to intentionally agitate or target others is prohibited." } 6. No Join/Leave Spamming :material-information-outline:{ title="Most users will have sound effects enabled, do not join and leave voice-chats rapidly." } 7. No Badgering Others (`@'ing`) :material-information-outline:{ title="This includes asking others repeatedly for a response after being ignored or told no." }