Merge branch...

Merge branch '1291-documentation-about-lfs-objects-not-being-copied-when-mirroring-is-active' into 'master'

Add notes about LFS/Annex objects not being synced

Closes https://gitlab.com/gitlab-org/gitlab-ee/issues/1291

- [x] Change docs
- [x] Change views

See merge request !917

app/views/projects/mirrors/_instructions.html.haml

@@ -6,3 +6,5 @@
       If your HTTP repository is not publicly accessible, add authentication information to the URL: <code>https://username:password@gitlab.company.com/group/project.git</code>.
     %li
       The update action will time out after 10 minutes. For big repositories, use a clone/push combination.
+    %li
+      The Git LFS/Annex objects will <strong>not</strong> be synced.

app/views/projects/mirrors/show.html.haml

@@ -8,7 +8,9 @@
       %h4.prepend-top-0
         Pull from a remote repository
       %p.light
-        Set up your project to automatically have its branches, tags, and commits updated from an upstream repository every hour.
+        Set up your project to automatically have its branches, tags, and commits
+        updated from an upstream repository every hour.
+        = link_to 'Read more', help_page_path('workflow/repository_mirroring', anchor: 'pulling-from-a-remote-repository'), target: '_blank'
     .col-lg-9
       %h5.prepend-top-0
         Set up mirror repository
@@ -49,7 +51,9 @@
       %h4.prepend-top-0
         Push to a remote repository
       %p.light
-        Set up the remote repository that you want to update with the content of the current repository every hour.
+        Set up the remote repository that you want to update with the content
+        of the current repository every hour.
+        = link_to 'Read more', help_page_path('workflow/repository_mirroring', anchor: 'pushing-to-a-remote-repository'), target: '_blank'
     .col-lg-9
       = render "shared/remote_mirror_update_button", remote_mirror: @remote_mirror
       - if @remote_mirror.last_error.present?

app/views/shared/_import_form.html.haml

@@ -14,6 +14,8 @@
           The import will time out after 15 minutes. For repositories that take longer, use a clone/push combination.
         %li
           To migrate an SVN repository, check out #{link_to "this document", "http://doc.gitlab.com/ce/workflow/importing/migrating_from_svn.html"}.
+        %li
+          The Git LFS/Annex objects will <strong>not</strong> be imported.
 
 .form-group
   .col-sm-offset-2.col-sm-10
@@ -23,6 +25,7 @@
         %strong
           Mirror repository
       .help-block
-        Automatically update this project's branches and tags from the upstream repository every hour.
+        Automatically update this project's branches and tags from the upstream
+        repository every hour. The Git LFS/Annex objects will not be synced.
 
 = f.hidden_field :mirror_user_id, value: current_user.id

doc/workflow/repository_mirroring.md

-# Repository Mirroring
+# Repository mirroring
 
-You can set up a project to automatically have its branches, tags, and commits updated from an upstream repository.
-This is useful when a repository you're interested in is located on a different server, and you want to be able to browse its content and its activity using the familiar GitLab interface.
+>[Introduced][ee-51] in GitLab Enterprise Edition 8.2.
 
-Mirror repositories are updated every hour, and all new branches, tags, and commits will be visible in the project's activity feed. Users with at least developer access to the project can also force an immediate update.
+There are two kinds of repository mirroring features supported by GitLab:
+**push** and **pull**. The **push** method mirrors the repository in GitLab
+to another location, whereas the **pull** method mirrors an external repository
+in one in GitLab.
 
-![Project page](repository_mirroring/project_page.png)
+Mirror repositories are updated every hour, and all new branches, tags, and
+commits will be visible in the project's activity feed.
 
-Since the repository on GitLab functions as a mirror of the upstream repository, you are advised not to push commits directly to the repository on GitLab. Instead, any commits should be pushed to the upstream repository, and will end up in the GitLab repository automatically within an hour, or when a forced update is initiated.
+Users with at least [developer access][perms] to the project can also force an
+immediate update with a click of a button.
 
-If you do manually update a branch in the GitLab repository, the branch will become diverged from upstream, and GitLab will no longer automatically update this branch to prevent any changes from being lost.
+A few things to consider:
 
-![Diverged branch](repository_mirroring/diverged_branch.png)
+- The repository must be accessible over `http://`, `https://` or `git://`.
+- If your HTTP repository is not publicly accessible, add authentication
+  information to the URL, like: `https://username:password@gitlab.company.com/group/project.git`.
+  In some cases, you might need to use a personal access token instead of a
+  password, e.g., you want to mirror to GitHub and have 2FA enabled.
+- The import will time out after 15 minutes. For repositories that take longer
+  use a clone/push combination.
+- The Git LFS/Annex objects will not be synced. You'll need to push/pull them
+  manually.
 
-## Set it up
+## Pulling from a remote repository
 
-### New projects
+You can set up a repository to automatically have its branches, tags, and commits
+updated from an upstream repository. This is useful when a repository you're
+interested in is located on a different server, and you want to be able to
+browse its content and its activity using the familiar GitLab interface.
 
-When creating a new project, you can enable Repository Mirroring when you choose to import the repository from "Any repo by URL".
+When creating a new project, you can enable repository mirroring when you choose
+to import the repository from "Any repo by URL". Enter the full URL of the Git
+repository to pull from and click on the **Mirror repository** checkbox.
 
-![New project](repository_mirroring/new_project.png)
+![New project](repository_mirroring/repository_mirroring_new_project.png)
 
-### Existing projects
+For an existing project, you can set up mirror pulling by visiting the
+**Mirror repository** page under the wheel icon in the upper right corner.
+Check the 'Mirror repository' box and hit **Save changes** at the bottom.
+You have a few options to choose from one being the user who will be the author
+of all events in the activity feed that are the result of an update. This user
+needs to have at least [master access][perms] to the project. Another option is
+whether you want to trigger builds for mirror updates.
 
-For existing projects, you can set up Repository Mirroring by navigating to Project Settings > Mirror Repository.
+![Pull settings](repository_mirroring/repository_mirroring_pull_settings.png)
 
-![Settings](repository_mirroring/settings.png)
+Since the repository on GitLab functions as a mirror of the upstream repository,
+you are advised not to push commits directly to the repository on GitLab.
+Instead, any commits should be pushed to the upstream repository, and will end
+up in the GitLab repository automatically within an hour, or when a
+[forced update](#forcing-an-update) is initiated.
+
+If you do manually update a branch in the GitLab repository, the branch will
+become diverged from upstream, and GitLab will no longer automatically update
+this branch to prevent any changes from being lost.
+
+![Diverged branch](repository_mirroring/repository_mirroring_diverged_branch.png)
+
+## Pushing to a remote repository
+
+You can set up mirror pushing to an existing GitLab project by visiting the
+**Mirror repository** page under the wheel icon in the upper right. Simply
+click the "Remote mirror repository" checkbox and fill in the Git URL of the
+repository to push to. Hit **Save changes** for the changes to take effect.
+
+![Push settings](repository_mirroring/repository_mirroring_push_settings.png)
+
+Similarly to the pull mirroring, since the upstream repository functions as a
+mirror to the repository in GitLab, you are advised not to push commits directly
+to the mirrored repository. Instead, any commits should be pushed to GitLab,
+and will end up in the mirrored repository automatically within an hour, or when
+a [forced update](#forcing-an-update) is initiated.
+
+In case of a diverged branch, you will see an error indicated at the
+**Mirror repository** settings.
+
+![Diverged branch](repository_mirroring/repository_mirroring_diverged_branch_push.png)
+
+## Forcing an update
+
+While mirrors update once an hour, you can force an update (either **push** or
+**pull**) by using the **Update now** button which is exposed in various places:
+
+- in the commits page
+- in the branches page
+- in the tags page
+- in the **Mirror repository** settings page
+
+[ee-51]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/51
+[perms]: ../user/permissions.md