sameersbn / sameersbn/docker-gitlab

Documentation links in GitLab are broken

Open
#726 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

wontfix
Dominant language
Shell
Stars
8.1k
Forks
2.1k
Avg merge
17h 47m
Merged PRs (30d)
7

Description

I am here (1) and I want to see some readme, e.g. about environment variables.

When I click on that link, it takes me to (2) but that page does not exist and results with 404 because when you notice, there are two "help/help" instead of one in (2). When I remove one "help" in the URL path like this (3) it works ok.

I am not sure if this is fault of this docker-gitlab thing or it is broken in upstream.

(1) https://my.gitlab.net/help/
(2) https://my.gitlab.net/help/help/administration/environment_variables.md
(3) https://my.gitlab.net/help/administration/environment_variables.md

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 by reproducing the broken link from https://my.gitlab.net/help/ and compare it with the working URL that removes one “help” path segment. Trace whether docker-gitlab or upstream GitLab generates the duplicated path; done when the environment-variables link resolves without the extra segment.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, gitlab, shell
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.