prometheus / prometheus/docs

Unable to compile docs due to error

Open
#2,063 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

technical-bug
Dominant language
TypeScript
Stars
717
Forks
1.2k
Avg merge
3d 15h
Merged PRs (30d)
19

Description

I am trying to compile docs to resolve an issue with routing tree webtool.

make compile crashed trying to do git reset inside alertmanager/release-0.19 folder

Part of crash log

error: Sparse checkout leaves no entry on working directory
fatal: Could not reset index file to revision 'HEAD'.

Captain! We’ve been hit!

RuntimeError: Running command 'cd /mnt/d/IdeaProjects/docs/tmp/repo_docs/alertmanager/release-0.19 && git reset --hard --quiet && git clean --force' failed

When I go to folder alertmanager/release-0.19 it is empty.
Manually invoking git reset --hard --quite gives the error as in above.
Other folders have docs folder inside and I can successfully do git reset on them.

UPD:
Problem appears on Windows 11 and maybe reproducible on Windows 10
I repeat all the steps on ubuntu without any issues

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the make compile entry point and reproduce the failure on Windows in alertmanager/release-0.19, where the checkout is empty. Compare the failing git reset --hard --quiet and git clean --force commands with a successful Ubuntu run. Done means documentation compilation completes on the affected Windows versions without the sparse-checkout reset error.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.