Create a documentation section for GitLab Label guidelines.

Also rename `gitlab.rst` to `gitlab-ci.rst` since we are starting
to document non-CI GitLab-related information in various places,
making `gitlab.rst` a misleading name.

Fixes #3949

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index be5483dbd4bcb1e47605e91c193195359a77a962..446603993201d9801391c900340e57782421c892 100644 (file)
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -338,7 +338,7 @@ if (SPHINX_FOUND)
         dev-manual/doxygen.rst
         dev-manual/error-handling.rst
         dev-manual/formatting.rst
-        dev-manual/gitlab.rst
+        dev-manual/gitlab-ci.rst
         dev-manual/gmxtree.rst
         dev-manual/includestyle.rst
         dev-manual/index.rst

diff --git a/docs/dev-manual/change-management.rst b/docs/dev-manual/change-management.rst
index a5cf8d824fa9c3217b0cd4fc57b4acef1689662c..e0fcd620b68f662c7d6df886c3d6d264119fe8af 100644 (file)
--- a/docs/dev-manual/change-management.rst
+++ b/docs/dev-manual/change-management.rst
@@ -84,6 +84,26 @@ Naming branches
 Good names: documentation_UpdateDevelopersDocsTOGitLab, nbnxm_MakeNbnxmGPUIntoClass, pme_FEPPMEGPU. 
 Bad names: branch1234, mybranch, test, etc
 
+Labels
+======
+
+Labels <https://docs.gitlab.com/ee/user/project/labels.html>`__ help developers by allowing additional filtering of issues and merge requests.
+
+The GROMACS project `defines many labels <https://gitlab.com/gromacs/gromacs/-/labels>`__.
+
+.. Note: labeling guidelines TBD. See https://gitlab.com/gromacs/gromacs/-/issues/3949 and open new issues as appropriate.
+
+In general:
+
+* Ongoing categorizations to help specify the GROMACS component or development area use the ``#7F8C8D`` color.
+* Specific features or subproject areas targeting an upcoming release use the ``#8E44AD`` background color.
+
+When creating a new label, please provide a short description
+so that people can understand what the label is intended to convey,
+and when they should apply it to their own issues or merge requests.
+
+.. Best practices and labeling policies can be proposed as changes to this document. See https://gitlab.com/gromacs/gromacs/-/issues/3949
+
 Code Review
 ===========
 
@@ -92,7 +112,7 @@ Reviewing someone else's uploaded code
 
 The reviewing workflow is the following:
 
-#. https://gitlab.com/gromacs/gromacs/-/issues shows all open changes
+#. https://gitlab.com/gromacs/gromacs/-/merge_requests shows all open changes
 #. A change needs two approvals to go in, of which one approval has to come from
    a member of either GMX Core or GMX Developers.
 #. Usually a patch goes through several cycles of voting, commenting and

diff --git a/docs/dev-manual/containers.rst b/docs/dev-manual/containers.rst
index 6ef5ddffff32aa089d19b1792754dcf217b5e875..eed17ec2ab742b91b4f8ca8140a1c5a35a6298ff 100644 (file)
--- a/docs/dev-manual/containers.rst
+++ b/docs/dev-manual/containers.rst
@@ -31,7 +31,7 @@ Steps:
 Refer to :file:`buildall.sh` in the ``master`` branch for the set of images
 currently built.
 
-Within :doc:`pipeline jobs <gitlab>`, jobs specify a Docker image with the *image* property.
+Within :doc:`pipeline jobs <gitlab-ci>`, jobs specify a Docker image with the *image* property.
 For image naming convention, see :py:func:`utility.image_name`.
 Images from the GitLab registry
 are easily accessible with the same identifier as above.

diff --git a/docs/dev-manual/gitlab.rst b/docs/dev-manual/gitlab-ci.rst
similarity index 100%
rename from docs/dev-manual/gitlab.rst
rename to docs/dev-manual/gitlab-ci.rst

diff --git a/docs/dev-manual/infrastructure.rst b/docs/dev-manual/infrastructure.rst
index 535a6888ae3d040e8c005a184fabea3c0a1a62bc..fd8c25e58c24a464c41b33ad667a9672cc30213b 100644 (file)
--- a/docs/dev-manual/infrastructure.rst
+++ b/docs/dev-manual/infrastructure.rst
@@ -10,6 +10,6 @@ performed by a Jenkins installation. With the resolution of :issue:`3272`,
     :maxdepth: 2
 
     jenkins
-    gitlab
+    gitlab-ci
     containers