docs: add git clone eof error troubleshooting

[Danyal-Faheem]

Issue

• Git throws an EOF error while cloning large repositories on slow/unstable networks.

RUN mkdir -p /openedx/edx-platform &&     git clone https://github.com/openedx/edx-platform.git --branch open-release/quince.1 --depth 1 /openedx/edx-platform:
Cloning into '/openedx/edx-platform'...
fatal: the remote end hung up unexpectedly
fatal: early EOF
fatal: index-pack failed

• This error is thrown while cloning edx-platform during the build process of the openedx/openedx-dev image.
  

  tutor/tutor/templates/build/openedx/Dockerfile

  Lines 41 to 43 in 13c420c

  	RUN mkdir -p /openedx/edx-platform && \
  	git clone $EDX_PLATFORM_REPOSITORY --branch $EDX_PLATFORM_VERSION --depth 1 /openedx/edx-platform
  	WORKDIR /openedx/edx-platform

Changes

• Added a troubleshooting guide for the issue thrown by git while cloning large repositories on slow/unstable networks.
• Since this issue is subjective to every users network connection, I have instead just added a troubleshooting guide to reduce resources in the buildkit which does fix the issue.

This error has been reported by multiple users, for example here and here. I myself have faced this as well.
The max I could try it out was on a 25 Mb/s wired connection and it still threw the error.

[regisb]

In what situation does this error occur? Unless I'm mistaken, this happens whenever we run tutor images build ... command, right? We should tell the reader that, such that they feel confident that the error that we are describing matches their experience.

Also, try to avoid the "you" pronoun whenever possible. For instance, some of the sentences can be rewritten as:

This issue can occur due to network problems while cloning edx-platform which is a fairly large repository.

First, try to run again the same command to see if it works.

[Danyal-Faheem]

I've updated the title with the sample command.

I've removed the "you" pronoun as well.

[regisb]

You left out the "your network" :) (and below as well)

[regisb]

This is good advice, but it does not inspire confidence. How many times should the user try to re-run the same command? Why should they do that?

[Danyal-Faheem]

I've added that the command should be run once again and why it should be run again.

[regisb]

Setting max-parallelism=1 is not great advice. I would suggest just forwarding the user to the above tutorial, and they can figure out by themselves what is the right paralellism value.

[Danyal-Faheem]

I've removed that part and just forwarded the user to the other tutorial.

[hinakhadim]

@regisb Would be please again have a look into it?

[regisb]

You left out the "your network" :) (and below as well)

[regisb]

👍