Patch #9129
closed
Improve wording of Git repository note at project setting
0%
Description
Setting up git usually involves either:
git clone git://github.com/ook/donebox.git
or
mkdir foo; cd foo; git init
Redmine wants its git repository set up in a "nonstandard", "bare" way.
So it's very easy to get the setup wrong (#9128), the error messages are not really helpful, there is no help from the setup page itself and the relevant help page in the Redmine wiki is hard to find and the text accompanying the relevant configuration option is easy to missunderstand.
I'd like to suggest the following changes:
1. change the text that accompanies the "path" configuration option from "Bare and local repository (e.g. /gitrepo, c:\gitrepo)" to "repository that is bare and local (e.g. /gitrepo, c:\gitrepo)". (see here for the rationale)
2. Add a "Help" link to the text that is accompanying the "path" configuration option, that points to http://www.redmine.org/projects/redmine/wiki/RedmineRepositories#Git-repository
Files
Related issues
Updated by Tomas Pospisek about 13 years ago
- File git-path-docu.patch git-path-docu.patch added
Second try, produced the correct patch
Updated by Toshi MARUYAMA about 13 years ago
- Assignee set to Toshi MARUYAMA
- Target version set to 1.3.0
Updated by Toshi MARUYAMA about 13 years ago
- Subject changed from Please improve wording of Git repository setup. Link to help to Improve wording of Git repository note at project setting
Updated by Toshi MARUYAMA about 13 years ago
- Status changed from New to Closed
Updated by Tomas Pospisek about 13 years ago
Hi Toshi,
But, I can not accept to add wiki link
so, allthough I've been now using git for like two years, Redmine was the first time I was introduced to the notion of a "bare" repository. I had never needed that feature before nor had any recipe on the internets.
If the user gets it wrong, will your error message point them to the wiki page or give instructions?
How are people, maybe even ones that are new to git, supposed to find out how to set up their repositories?
Try once how hard it is to find the correct wiki help page through Redmine's search. Also check the number of people that get stuck:
http://www.google.com/search?q=%22fatal%3A+Not+a+git+repository%22+git+redmine(it took me about 5 hours yesterday, which included debugging the code on a Windows machine)
It'd be nice if the setup was trivial and everybody got it correctly setup without any problems at all in an instant? So what's the way to get to that point?
Updated by Toshi MARUYAMA about 13 years ago
The bare repository requirement is one of FAQs before 1.1.
So, I added bare word.
Other FAQs:
- Repository permission
- command path
- repository path
- file://gitrepo and file://hgrepo are incorrect.
Other FAQs are subversion xml parsing error and #4741.
So I will improve fetching error message.
I think the bare repository requirement description is enough in r6640.