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