Patch #9129

Improve wording of Git repository note at project setting

Added by Tomas Pospisek about 6 years ago. Updated over 1 year ago.

Status:ClosedStart date:2011-08-26
Priority:NormalDue date:
Assignee:Toshi MARUYAMA% Done:

0%

Category:SCM
Target version:1.3.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

git-path-docu.patch Magnifier (791 Bytes) Tomas Pospisek, 2011-08-26 03:43

git-path-docu.patch Magnifier (799 Bytes) Tomas Pospisek, 2011-08-26 03:45


Related issues

Related to Redmine - Patch #8594: pt-BR translation update Closed 2011-06-11
Related to Redmine - Defect #9128: Redmine sugestion of the git repository path is incorrect Closed 2011-08-25
Related to Redmine - Feature #4741: Improve Bazaar repositories error message in case to use ... New 2009-02-21
Related to Redmine - Patch #9210: Traditional Chinese language file (to r7077) Closed 2011-09-09

Associated revisions

Revision 6636
Added by Toshi MARUYAMA about 6 years ago

temporarily hard-cord git repository note at project setting (#9129).

Contributed by Tomas Pospisek.

Revision 6637
Added by Toshi MARUYAMA about 6 years ago

temporarily remove git repository note from locale files (#9129).

Revision 6638
Added by Toshi MARUYAMA about 6 years ago

improve git repository note at project setting (#9129).

Contributed by Tomas Pospisek.

Revision 6639
Added by Toshi MARUYAMA about 6 years ago

readd Japanese translation "text_git_repository_note" (#9129).

Revision 6640
Added by Toshi MARUYAMA about 6 years ago

regenerate i18n text "text_git_repository_note" (#9129).

Revision 7079
Added by Toshi MARUYAMA about 6 years ago

Traditional Chinese translation updated by ChunChang Lo (#9210, #9129)

Translations readded:
  • text_git_repository_note

Revision 7797
Added by Toshi MARUYAMA about 6 years ago

Simplified Chinese "text_git_repository_note" translation updated by Steven Wong (#9558, #9129)

History

#1 Updated by Tomas Pospisek about 6 years ago

Second try, produced the correct patch

#2 Updated by Toshi MARUYAMA about 6 years ago

  • Assignee set to Toshi MARUYAMA
  • Target version set to 1.3.0

#3 Updated by Toshi MARUYAMA about 6 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

#4 Updated by Toshi MARUYAMA about 6 years ago

  • Status changed from New to Closed

I accept your request of improvement git note from r6636 to r6640 in trunk.
Because #8594 has a suggestion to change git note.

But, I can not accept to add wiki link.
  • It is too hard to maintain.
  • It is strange in only git setting.
  • I will improve fetching error message at #4741.

#5 Updated by Tomas Pospisek about 6 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?

#6 Updated by Toshi MARUYAMA about 6 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.

#7 Updated by Toshi MARUYAMA over 1 year ago

  • Description updated (diff)

Also available in: Atom PDF