Guidelines for Project Managers¶
- Guidelines for Project Managers
Who may host a project on code.zmaw.de?¶
How to create a project?¶
To request a new project, please contact the redmine admins via firstname.lastname@example.org. We will create an empty one for you and permit management. After logging in, you'll see a link "Settings" on the right end of the projects navigation bar. Choose this for further configuration: Setting the description, select modules that should be available within your project, create a wiki or forums and connect the project to a source code repository and manage project members. Issue categories may ease working bug and feature requests, and versioning can help in organizing your code. Subprojects (depth restricted to one level by technical limits) can be created by the manager of the parent project.
The redmine developers offer an online demo of their work: http://demo.redmine.org. Feel free to register for an account and play around with redmine.
Public or Private?¶
Code from the repositories of public projects is readable for all registered redmine users (that includes external users!).
Documentation (wiki pages, documents) is currently viewable even for anonymous visitors to ease getting help and information, and also to ease
project administration, as administrators only need to manage users that do need extended access to more advanced roles (bug-reporting or even managing for example).
If your code or project information needs to be hidden from all people but members of your project, you need to declare the project to be private during project-creation (or later reconfiguration via settings -> information). Users won't be able to even notice the existence of a private project until they have been added as that projects member by the project manager. You probably want to use private projects for example to manage a groups or departments internal strategic discussions.
Unfortunately there's now way to use fine-grained permissions on a per-project level at the moment. The MPIM decided, that all MPIM projects should have the group "MPI Intern" with at least the role "MPIM non member" assigned to every project (exceptions need to be accepted by one of the directors), so MPIM staff can view, what's going on at the institute.
Some clarifications about Redmines access-management and how it may fit that need are developed here.
Roles and Permissions¶
Check the menupoint Information from the upper left menu and check the Permissions report and the Workflows to understand, what a user with a specific role is allowed to do and grant your project members the roles they need to do their work with the project. "Manager", "Developer" and "Reporter" are Redmine standard roles which probably fit best for most of the projects, especially software development projects.
Please note, that you cannot add users to your project that have never logged in to Redmine - Redmine is linked with the central LDAP-accounts, but these are only visible after a first login - please ask colleagues you'd like to add to your projects to login to Redmine if they never have before. Internal Users should always use the LDAP-coupled accounts, not register a Redmine internal account!
The general guideline for configuring access to your projects repository within Redmine is:
- Don't use your personal account for fetching data from the repository. Please create a generic user with read-access to the related repository. For code hosted on svn.zmaw.de, the username should have the form: "redmine-<projectname>". If you don't know who can create such a generic svn-account for your project, the ZMAW/CEN/MPIM IT Helpdesk may be able to guide you.
- use encrypted repository access (e.g. https instead of http) wherever possible
Independently from the generic users access rights, Redmine doesn't change the code. It's possible to annotate code with Redmine, but you cannot edit the code here.
Repository access has a "one repository per project" technical limit. To access several Repositories, you'll need to create subprojects within a master project.
Access to git repositories¶
To access a git repository, the repository needs to be cloned on our Redmine server. This will be set up by one of the Redmine admins on request.
- The owner of git repository is authorized to update the cloned repository via
git push. For this, he must provide the public ssh key by which access will be authenticated, and the name of the server on which the repository resides.
- On the Redmine server, an empty repository is created to hold the cloned git data, owned by the user
- The owner of the original git repository as well as the Redmine project manager will receive the path to this clone repository, eg.
/srv/repos/git/clone.git. It's the path to be entered as the 'path to git directory' in the Redmine repository settings.
- The owner may then provide the clone with data, using
git push --all ssh://email@example.com/srv/repos/git/clone.git
- To keep the clone up-to-date, the git repository's
post-receivehook script should be activated. With this you may initiate an automatic push to the clone repository after each push to the git repository. eg. like
cd /path/to/git/repository git push --all ssh://firstname.lastname@example.org/srv/repos/git/clone.git
If the git repository may be used directly with
git commit, these lines must also be put into the
This setup only works within the ZMAW and DKRZ network domains. The Redmine server does not allow direct access to a remote git repository.
What's "Repository Mapping"?¶
If your repositories usernames or mail-addresses match with the Redmine-usernames, Redmine can match them automatically. If this is not the case, project managers can create manual mappings between them. To do that, the project manager can find the related settings at <Project> -> "Settings" -> "Repository"-Tab -> "Users". There's a list with usernames from the code repository which you can match to redmine-users that are members of your project through a dropdown menu.
Embedded HTML/Way of Documentation¶
Our service is able to display HTML files as embedded code through the Redmine's Embedded Plugin. Files can be uploaded as zip-archives, new uploads overwrite old information. If your project already has a large amount of HTML-Documentation, check back with us for the best way to include them in Redmine. Apart from that, you can upload files in the "Documents"-Module of your project for representation regardless of the project's style.
However, if your project currently has no (more or less) automatically generated documentation in HTML, please try to use Redmines default ways of storing information (Wiki/Document Uploads).