summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Schubert <james.schubert@gmail.com>2018-08-08 22:36:31 -0400
committerJim Schubert <james.schubert@gmail.com>2018-08-08 22:36:31 -0400
commit13ea18d57e7dff6c8022c112581d4fa524fa3edb (patch)
tree750d77755457fb90cc87a24c4aee6d175d96bd21
parent68082d352516b5367fce76453b8992f4e44d127e (diff)
downloadgitlab-ce-docs-clarify-git-scp-style.tar.gz
Add clarification points to using SCP style URIsdocs-clarify-git-scp-style
This addresses user-facing documentation related to repository mirroring. On the repositoring mirroring view of repository settings, inputting either git@example.com:group/project.git or any variation of schemes: * https://git@example.com:group/project.git * http://git@example.com:group/project.git * git://git@example.com:group/project.git * ssh://git@example.com:group/project.git Fails on URL validation. This commit adds notes about the required format to the doc and view for repository mirroring. This commit does not attempt to validate the URL. see #47544
-rw-r--r--app/views/projects/mirrors/_instructions.html.haml2
-rw-r--r--doc/workflow/repository_mirroring.md2
2 files changed, 4 insertions, 0 deletions
diff --git a/app/views/projects/mirrors/_instructions.html.haml b/app/views/projects/mirrors/_instructions.html.haml
index 64f0fde30cf..c74865be3f8 100644
--- a/app/views/projects/mirrors/_instructions.html.haml
+++ b/app/views/projects/mirrors/_instructions.html.haml
@@ -8,3 +8,5 @@
The update action will time out after 10 minutes. For big repositories, use a clone/push combination.
%li
The Git LFS objects will <strong>not</strong> be synced.
+ %li
+ SCP-style URLs (<code>git@example.com:group/project.git</code>) must be converted to a URL format of <code>scheme://git@example.com/group/project.git</code>.
diff --git a/doc/workflow/repository_mirroring.md b/doc/workflow/repository_mirroring.md
index 8c4e6ea8eab..9056fd95ae4 100644
--- a/doc/workflow/repository_mirroring.md
+++ b/doc/workflow/repository_mirroring.md
@@ -139,6 +139,8 @@ enable mirroring (if not already enabled) and enter an `ssh://` URL.
> **NOTE**: SCP-style URLs, e.g., `git@example.com:group/project.git`, are not
supported at this time.
+>
+These URLs must be converted to the format `scheme://git@domain/group/project.git`
Entering the URL adds two features to the page - `Fingerprints` and
`SSH public key authentication`: