Skip to content

Commit

Permalink
docs: add info about cloning repo on unstable connections to FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Dec 13, 2024
1 parent 1d5ab61 commit 0065687
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion docs/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ into your language.
### What technologies are used in FMTM?

FMTM is built using several technologies, including FastAPI,
Postgres, React, and web components. The codebase is written in
Postgres, React, Svelte, and web components. The codebase is written in
Python & TypeScript mostly.

---
Expand All @@ -288,6 +288,50 @@ Please follow the instructions in the setup guide on this site.

---

### Help! Cloning the repo doesn't work for me

If you are receiving errors cloning the repo, it may be an unstable internet
connection causing issues.

First, please check your internet connection, or use another connection if
possible.

One option to reduce the amount of content that needs to be downloaded
is to do a shallow clone:

```bash
# Shallow clone only the `development` branch
git clone --depth 1 --no-single-branch https://github.com/hotosm/fmtm.git
```

To pull additional branches as you need them (for example, to work on them):

```bash
git fetch origin branch-name
git checkout branch-name
```

As an **absolute last resort**, you could try the following:

```bash
# Set HTTP version to 1.1 for stability (multiple connections vs multiplexing)
git config --global http.version HTTP/1.1

# Increase timeout to 3 minutes
git config --global http.lowSpeedTime 180

# Allow retries in case of failure
git config --global http.retry 3

# Disable integrity checks for easier resume
git config --global fetch.fsckObjects false
git config --global fetch.writeCommitGraph false

# Your clone command here...
```

---

### How can I report a bug or suggest a new feature for FMTM?

You can report bugs or suggest new features by opening an issue on
Expand Down

0 comments on commit 0065687

Please sign in to comment.