getodk / getodk/docs

Git LFS rate limit exceed

Open
#874 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

When checking out the docs anonymously git will often error during the LFS portion because of rate limit constraints. Unfortunately when this occurs, it leaves git in a bad state and it is non obvious how to fix your local repo. Since we want to encourage many novice users to contribute to the docs it would be nice if 1) we could fix this or 2) make our automated setup in docker better so new users don't hit the rate limit.

Scenario: new users get discouraged because their checkout does not complete and when they try to compile the docs they experience error messages. Advanced users/developers likely are logged into github and do not experience the issue.

Here are older issues that discuss the problem and can provide more insights that authenticated users are different;
https://github.com/git-lfs/git-lfs/issues/797
https://github.com/git-lfs/git-lfs/issues/2134

Contributor guide

Open the contributing guide

Research direction

Start by reproducing an anonymous docs checkout and the subsequent compile failure, then read the linked Git LFS issues for context on authenticated versus anonymous users. Inspect the automated Docker setup and checkout flow mentioned in the report. Done means novice users can complete checkout and compile the docs without hitting the rate-limit failure or being left with an unusable repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, git, python
Domain
devops, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.