From 88ceb249be943a897c905ad21beae30e8a67f57e Mon Sep 17 00:00:00 2001
From: Nicolas Dufresne <nicolas.dufresne@collabora.com>
Date: Tue, 5 Oct 2021 09:06:32 -0400
Subject: [PATCH] ci: Document the difference between the two doc jobs

Naming is hard, so I opted for a small comment to explain this one.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1054>
---
 .gitlab-ci.yml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 8e7a44dd68..e953460d10 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -857,6 +857,10 @@ valgrind ges:
     - documentation/
     - plugins-cache-diffs/
 
+#
+# This jobs runs in gsrtreamer namespace when after the merge into main branch.
+# The produced artifact is later used to automatically update the web page.
+#
 documentation:
   stage: integrate
   extends:
@@ -865,6 +869,10 @@ documentation:
   rules:
     - if: '$CI_PROJECT_NAMESPACE == "gstreamer" && $CI_COMMIT_BRANCH == "main"'
 
+#
+# This job is run in users namespace to validate documentation before merging
+# MR.
+#
 build documentation:
   extends:
     - '.documentation'