From 420c19433fbecba03220da2cc1268b7d27e3a643 Mon Sep 17 00:00:00 2001
From: FLETCHER <sf5715@att.com>
Date: Wed, 27 Jan 2021 10:27:59 -0600
Subject: [PATCH] docs: Add Windows help with vagrant

Some users that run vagrant on their Windows machine may need to update
some git configurations prior to running vagrant up. This adds a note
for the steps.

Change-Id: If6ae8495802eb20883a5f0615f8d8c15d28f05fe
---
 doc/source/install/jarvis/vagrant.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/doc/source/install/jarvis/vagrant.rst b/doc/source/install/jarvis/vagrant.rst
index 3d9d35d2..b336b421 100644
--- a/doc/source/install/jarvis/vagrant.rst
+++ b/doc/source/install/jarvis/vagrant.rst
@@ -20,6 +20,29 @@ A vagrant file is provided under ``tools/deployment/vagrant``, running
 ``vagrant up`` from this directory should bring up and deploy a copy of the
 Jarvis AIO.
 
+.. note:: If running in a Windows machine, a common error is the incorrect carriage
+   returns and symlinks not being created correctly when cloning your git repository.
+   This can be fixed by doing the following:
+
+   1. Run your editor in Administrator mode
+   2. ``cd`` into your cloned git repository
+
+   View all of the configurations for your git repository in step 3.
+   Duplicates may show up in this list because this command shows ALL git config (system, global,
+   local). Any config defined at the local level will take precedent over config at the system or
+   global level. If the below commands do not work, keep in mind that these are the values that
+   core.autocrlf and core.symlinks need to have in order to work.
+   (If you set ``git config --global core.symlinks true``, and there is a local ``core.symlinks``
+   defined to false, the false will take precedent.)
+
+   3. Run ``git config --list``
+   4. Run ``git config --global core.autocrlf false``
+   5. Run ``git config core.symlinks true``
+   6. Run ``git status``
+   7. Run ``git restore tools/gate/jarvis/100-deploy-k8s.sh``
+   8. Now proceed with the vagrant up command from the directory above
+
+
 .. note:: For Vagrant to work, a virtualization provider (e.g. ``Virtualbox``,
   ``libvirt``) is required. The recommended provider in the
   ``Vagrantfile`` is ``Virtualbox``, however, ``libvirt`` is included. To