Commit 41933505 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add pre-requisites about root group path and public visibility

parent 7e8fd57b
Loading
Loading
Loading
Loading
Loading
+14 −0
Original line number Diff line number Diff line
@@ -17,8 +17,22 @@ Don't panic, we provide all required tools to initiate it for the first time, an
The GitLab Synchronization Script has the following requirements:

* Bash interpreter <br/>_Trivial on Linux or MacOS, tested with [Git Bash](https://www.atlassian.com/git/tutorials/git-bash) on Windows (available in [Git for Windows](https://gitforwindows.org/))_
* [curl tool](https://curl.se/) installed and accessible as `curl` command from the Bash interpreter
* [jq tool](https://stedolan.github.io/jq/download/) installed and accessible as `jq` command from the Bash interpreter

:warning: by default and preferably, the GitLab Synchronization Script will clone the tbc group:

* to the `to-be-continuous` root group on your GitLab server,
* with public visibility.

If one or both of these requirements can't be met (because you're not allowed to create a root group in your organization and/or 
not allowed to create projects with public visibility), then you'll have to override the default options or variables:

* `--dest-sync-path` / `$DEST_SYNC_PATH` to override the GitLab destination root group path,
* `--max-visibility` / `$MAX_VISIBILITY` to override the maximum visibility of projects in the destination group.

For more info, [see script doc](https://gitlab.com/to-be-continuous/tools/gitlab-sync#usage-script).

### Run the GitLab Synchronization Script

1. Create an empty `to-be-continuous` root group with `public` visibility.