New dev workflow:
Contribution now have to be made on the main branch. A new `documentation` branch is created. Github and Gitlab pipelines are now working on this branch. Develop branch is deprecated, as it is no more necessary.
This commit is contained in:
parent
9fd4876e23
commit
0eb7e75421
4
.github/workflows/gh-pages.yml
vendored
4
.github/workflows/gh-pages.yml
vendored
@ -3,7 +3,7 @@ name: github pages
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main # Set a branch to deploy
|
||||
- documentation # Set a branch to deploy
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
@ -26,7 +26,7 @@ jobs:
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
if: github.ref == 'refs/heads/main'
|
||||
if: github.ref == 'refs/heads/documentation'
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./support/documentation/public
|
||||
|
@ -11,4 +11,4 @@ pages:
|
||||
paths:
|
||||
- public
|
||||
only:
|
||||
- main
|
||||
- documentation
|
||||
|
@ -7,7 +7,11 @@ chapter=false
|
||||
|
||||
Sprechen Sie immer über die Funktionen, die Sie entwickeln wollen, indem Sie das Issue, das Ihr Problem behandelt, erstellen/finden und kommentieren bevor Sie mit der Arbeit daran beginnen und informieren Sie die Gemeinschaft darüber, dass Sie mit der Programmierung beginnen, indem Sie das Thema für sich beanspruchen.
|
||||
|
||||
Bitte benutzen Sie den `develop` Zweig. Der `main`-Zweig ist für veröffentlichte Versionen des Plugins reserviert, so dass die Dokumentation immer mit der veröffentlichten Version des Plugins synchronisiert ist.
|
||||
Bitte benutzen Sie den `main` Zweig.
|
||||
|
||||
{{% notice note %}}
|
||||
Until march 2023, contribution were made on the `develop` branch. This procedure is now deprecated.
|
||||
{{% /notice %}}
|
||||
|
||||
Voraussetzung für die Erstellung dieses Plugins:
|
||||
|
||||
@ -19,8 +23,8 @@ Um das Repository zu klonen:
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
|
||||
# Checkout the develop branch
|
||||
git checkout develop
|
||||
# Checkout the main branch
|
||||
git checkout main
|
||||
# Initialize the submodules. This command must be run again if any submodules' version changes.
|
||||
git submodule update --init --recursive
|
||||
|
||||
|
@ -8,7 +8,11 @@ chapter=false
|
||||
Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
|
||||
before you start working on it, and inform the community that you begin coding by claiming the issue.
|
||||
|
||||
Please use the `develop` branch. The `main` branch is reserved to released versions of the plugin, so that the documentation is always synchronized with the released version of the plugin.
|
||||
Pull Request must be done on the `main` branch.
|
||||
|
||||
{{% notice note %}}
|
||||
Until march 2023, contribution were made on the `develop` branch. This procedure is now deprecated.
|
||||
{{% /notice %}}
|
||||
|
||||
Prerequisite for building this plugin:
|
||||
|
||||
@ -20,8 +24,8 @@ To clone the repository:
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
|
||||
# Checkout the develop branch
|
||||
git checkout develop
|
||||
# Be sure to checkout the main branch
|
||||
git checkout main
|
||||
# Initialize the submodules. This command must be run again if any submodules' version changes.
|
||||
git submodule update --init --recursive
|
||||
|
||||
|
@ -7,7 +7,11 @@ chapter=false
|
||||
|
||||
Toujours annoncer les fonctionnalités sur lesquelles vous voulez travailler en créant un ticket ou en commentant un ticket existant, avant de commencer à travailler dessus. Et annoncez clairement à la communauté que vous commencez à travailler dessus. Ceci afin d'éviter que plusieurs personnes travaillent sur la même chose et entrent en conflit.
|
||||
|
||||
Merci d'utiliser la branche `develop`. La branche `main` est réservée aux versions publiées, pour que la documentation affichée reste synchronisée avec la version publiée du plugin.
|
||||
Les Pull Request sont à faire sur la branche `main`.
|
||||
|
||||
{{% notice note %}}
|
||||
Jusqu'à mars 2023, il fallait contribuer sur la branche `develop`. Cette procédure est désormais obsolète.
|
||||
{{% /notice %}}
|
||||
|
||||
Pré-requis pour compiler le plugin:
|
||||
|
||||
@ -19,8 +23,8 @@ Pour clôner le dépot :
|
||||
```bash
|
||||
# Cloner le dépot
|
||||
git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
|
||||
# Passer sur la branche develop
|
||||
git checkout develop
|
||||
# Passer sur la branche main si ce n'est pas déjà le cas
|
||||
git checkout main
|
||||
# Initialiser les sous-modules. Cette commande est à refaire si jamais la version d'un l'un des sous-module change.
|
||||
git submodule update --init --recursive
|
||||
|
||||
|
@ -10,7 +10,7 @@ chapter=false
|
||||
Informieren Sie die Community immer vor der Arbeit (indem Sie ein neues Problem erstellen oder ein bestehendes kommentieren). Damit soll vermieden werden, dass zwei Personen
|
||||
an der gleichen Sache arbeiten, und Konflikte zu verhindern.
|
||||
|
||||
Bitte benutzen Sie den `develop`-Zweig. Der `main`-Zweig ist für veröffentlichte Versionen des Plugins reserviert, so dass die Dokumentation immer mit der veröffentlichten Version des Plugins synchronisiert ist.
|
||||
Bitte benutzen Sie den `main`-Zweig.
|
||||
|
||||
Der Quellcode der Dokumentation befindet sich im Ordner `support/documentation/content`.
|
||||
|
||||
@ -20,6 +20,10 @@ Sie müssen es auf Ihrem Computer installieren, wenn Sie eine Vorschau Ihrer Arb
|
||||
Das verwendete Thema ist [hugo-theme-learn](https://learn.netlify.app/).
|
||||
Sie sollten dessen Dokumentation lesen, bevor Sie mit der Bearbeitung der Dokumentation beginnen.
|
||||
|
||||
When a new plugin version is released, or when documentation is updated,
|
||||
plugin maintainers will merge the `main` branch to the `documentation` branche.
|
||||
This will trigger github and gitlab pipelines, and update published documentation.
|
||||
|
||||
## Übersätzungen
|
||||
|
||||
Die Hauptsprache ist Englisch (Code `en`).
|
||||
|
@ -10,7 +10,7 @@ chapter=false
|
||||
Always inform the community before working (by creating a new issue, or commenting an existing one). This is to avoid that two persons are
|
||||
working on the same thing, and prevent conflicts.
|
||||
|
||||
Please use the `develop` branch. The `main` branch is reserved to released versions of the plugin, so that the documentation is always synchronized with the released version of the plugin.
|
||||
Documentation work has to be merged in the `main` branch.
|
||||
|
||||
The documentation source code is in the `support/documentation/content` folder.
|
||||
|
||||
@ -20,6 +20,10 @@ You have to install it on your computer if you want to preview your work.
|
||||
The used theme is [hugo-theme-learn](https://learn.netlify.app/).
|
||||
You should read its documentation before starting editing the documentation.
|
||||
|
||||
When a new plugin version is released, or when documentation is updated,
|
||||
plugin maintainers will merge the `main` branch to the `documentation` branche.
|
||||
This will trigger github and gitlab pipelines, and update published documentation.
|
||||
|
||||
## Translations
|
||||
|
||||
The principal language is english (`en` code).
|
||||
|
@ -11,9 +11,7 @@ Toujours vous annoncer avant de commencer à travailler (en créant un ticket ou
|
||||
en commentant un ticket existant). Ceci afin d'éviter que plusieurs personnes
|
||||
travaillent sur la même chose et entrent en conflit.
|
||||
|
||||
Merci d'utiliser la branche `develop`.
|
||||
La branche `main` est réservée aux versions publiées, pour que la documentation
|
||||
affichée reste synchronisée avec la version publiée du plugin.
|
||||
Le travail de documentation se fait sur la branche `main`.
|
||||
|
||||
Le code source de la documentation se trouve dans le dossier
|
||||
`support/documentation/content` du dépot de code.
|
||||
@ -25,6 +23,11 @@ documentation.
|
||||
Le thème utilisé est [hugo-theme-learn](https://learn.netlify.app/).
|
||||
Il est recommandé d'en lire la documentation avant de commencer.
|
||||
|
||||
Quand une version du plugin est publiée, ou quand la documentation est mise
|
||||
à jour, les mainteneur⋅euses du plugin fusionnerons la branche `main` dans
|
||||
la branche `documentation`, ce qui aura pour effet de déclencher les pipelines
|
||||
github et gitlab pour mettre à jour les versions publiées.
|
||||
|
||||
## Traductions
|
||||
|
||||
La langue principale est l'anglais (code `en`).
|
||||
|
@ -7,7 +7,13 @@ chapter=false
|
||||
|
||||
Sie können uns helfen, dieses PeerTube-Plugin zu übersetzen, indem Sie Übersetzungsdateien im Ordner `languages` erstellen oder ändern.
|
||||
|
||||
Bitte arbeiten Sie auf dem `develop` Zweig, und machen Sie Ihre Änderungen und Pull Requests auf diesem Zweig.
|
||||
{{% notice tip %}}
|
||||
Bitte arbeiten Sie auf dem `main` Zweig, und machen Sie Ihre Änderungen und Pull Requests auf diesem Zweig.
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice note %}}
|
||||
Until march 2023, contribution were made on the `develop` branch. This procedure is now deprecated.
|
||||
{{% /notice %}}
|
||||
|
||||
Wenn die Sprache, für die Sie sich interessieren, noch nicht existiert, erstellen Sie eine Datei `code.json` im Ordner `languages`, wobei `code` der Code der Sprache ist.
|
||||
Der Sprachcode muss derselbe sein wie der Sprachcode von Peertube (siehe [Peertube-Dokumentation](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/translation.md)).
|
||||
|
@ -12,7 +12,11 @@ For now, translation is done in the git repository. Later in 2023, online transl
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice tip %}}
|
||||
Please work on the `develop` branch, and do your commits and pull request on this branch.
|
||||
Please work on the `main` branch, and do your commits and pull request on this branch.
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice note %}}
|
||||
Until march 2023, contribution were made on the `develop` branch. This procedure is now deprecated.
|
||||
{{% /notice %}}
|
||||
|
||||
## Standard application strings
|
||||
|
@ -15,7 +15,11 @@ Le processus de traduction en sera plus simple.
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice tip %}}
|
||||
Merci de travailler sur la branche `develop`, et de faire vos _pull request_ sur cette branche.
|
||||
Merci de travailler sur la branche `main`, et de faire vos _pull request_ sur cette branche.
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice note %}}
|
||||
Jusqu'à mars 2023, il fallait contribuer sur la branche `develop`. Cette procédure est désormais obsolète.
|
||||
{{% /notice %}}
|
||||
|
||||
## Chaîne applicatives standard
|
||||
|
Loading…
Reference in New Issue
Block a user