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:
John Livingston
2023-03-07 14:14:19 +01:00
parent 9fd4876e23
commit 0eb7e75421
11 changed files with 57 additions and 20 deletions

View File

@ -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`).

View File

@ -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).

View File

@ -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`).