Administrator guide
Requesting a project
Please send an email to Javier.Serrano (insert a "@" here) cern.ch in order to ask for a project to be created. You will need to specify:
- A project name
- Brief description of your project
- Type of license
- Initial team
- Any special requirements
OHWR features
Redmine provides the following modules per Project
- Issue management & time tracking (via tickets)
- News module
- Documents module
- Files module
- Wikis (1 per project)
- Forums (can create multiple forums per project)
- Subversion repositories (1 per project)
- Mailing lists (1 per project)
Recommended setup & usage
We recommend the following usage:
- Use the issues tracker to create issues, tasks, milestones and deadlines for your project, and assign it to your team members. Think of issues as "tickets" they allow you to plan tasks and future features, as well as to be used for bug tracking.
- The mailing list is the preferred way of communication, but you can also use forums.
- Use subversion (SVN) for all kinds of files requiring version management: HDL and software/firmware, schematics, PCB layout, manufacturing files, etc.
- Use the Documents module for providing "release" versions of Documents; Typically you would show versions 1.0, 2.0 and 3.0 on the Documents section, and all the intermediate steps (1.1, 2.3.1, etc) would be managed via the SVN.
- Similarly, use the Files section for "release" versions of important files, such as binary installation programs, drivers, schematics, gerber files, firmware etc. Again, intermediate versions of these should be managed via subversion.
- Use the wiki for storing the information you want to conserve about your project, but for which you don't have specific documents; meeting minutes, informal, high-level descriptions, objectives, etc.
- Use the News section for publishing important events, such as a new exposition or review meeting.
One alternative to the use of the Documents and Files modules is to have a dedicated documentation wiki page with links to important files in the SVN repository. This has the advantage of not duplicating files and the disadvantage of a (potentially) less intuitive navigation experience for the occasional visitor.
Adding new users
New users should apply for an account with the Register link (top-right of the screen). They will have to be approved by an administrator (Javier).
An administrator can register new users via the following link: https://www.ohwr.org/users/new
If you are not an administrator and need to create lots of new users, please open a ticket on ohr-support. You will need to specify the user names and email addresses there - an attached text file is recommended.
Once approved, users can be given roles on a project via the project's Settings / Members tab by a project manager.
Repositories (SVN)
If you have requested it, your project will include a subversion repository. All project's repositories are available on the following URL:
You can calculate the complete url of your repository by adding /
and
your project's identifier to that url. For example, the source code of
this page is on the ohr-support
repository:
http://svn.ohwr.org/ohr-support
This URL is publicly available on read-mode (everyone can "update" from these repositories).
Anyone wanting to commit changes to a project will have to be authenticated as a developer or manager on that project.
If you only want to browse the source code, notice that Redmine provides a nicer interface via its "Repository" tab (you should see it on the toolbar, above this text). It is also possible to include links to particular releases or files (see the "wiki editing guide"/help/wiki_syntax_detailed.html for details).
Repositories (Git)
See the dedicated wiki page for details.
Mailing Lists (Sympa)
If you have requested it, your project will include a mailing list. Mailing lists are managed via a sympa interface.
OHWR's mailing lists interface is available here:
You can calculate the complete url of your mailing list's by adding
/sympa/info/
and your project's identifier to that url. For example,
ohr-support
's mailing list page is here:
http://lists.ohwr.org/sympa/info/ohr-support
From there, you can browse the mailing list's archive, list of users, etc.
Mailing list archives are publicly available. There's no way to make private mailing lists.
If you are a project's manager, an account will be created for you on the sympa system. Your login and password will be the same as you use on the ohwr site. You will have owner rights over that list.
Appart from that, sympa's subscriptions are separated and independent from the rest of ohwr's accounts; It's possible to be a member of a project, and not be subscribed to its mailing list (in fact, newly created users are NOT automatically subscribed to the project's mailing list; they have to proactively subscribe - see below). It's also possible to be subscribed to a sympa mailing list while not having a project account (this is useful for external mail-only collaborators).
There isn't any procedure for automatically subscribing new project users to a mailing lists; only list owners are created automatically from project managers. The sympa web interface provides the lists owners with a way to mass-subscribe lots of users via uploading of a text file. We however recommend keeping the subscription voluntary.
The instructions for joining a list can be found on each project's "Mailing List" tab; see ohr-support mailing list page for an example.
Mailing lists are open; anyone can send an email to them, including unregistered users. Emails from unregistered users will be moderated by the mailing list owners (they will receive a private email when an email from an unregistered user arrives).
Creating a project with a github mirror repository
CERN admin (Javier)
- Create the project with the repository flag deactivated.
- Open a support ticket detailing:
- The project id
- The github repository url
Splendeo admin (egarcia, fjuan)
- Read docuemtation at plugin repository
- git clone the repository into the local repository folder
- Activate the repository flag for the project, and then go to
Settings/Repository and set the following fields:
- type of repository: git
- Path to Repository field pointing to the final /.git/ folder
- Overwrite default settings for checkout url: Yes
- Checkout url: the git:// (read-only address) for the repository on github
- Render checkout URL as a link: Yes
- Display Login: No login or password
Send the hookup url to the CERN admin. It should look like this:
https://www.ohwr.org/github_hook?project_id=ohwr_project_identifier
. Note that the id=
parameter is needed only if the github repository
name is different from the Ohwr project identifier.
CERN admin
- Send the github hook url to the github admin
Github repository admin
- Go to your project's github page, and then to Admin / Service Hooks / Post-Receive URLs .
- Insert exactly the url that you have received. It should look like this: https://www.ohwr.org/github_hook?project_id=ohwr_project_identifier . The ?project_id=... might not appear.
- Test the hook by re-visiting the page and clicking on the "test" button.
- Official documentation: http://help.github.com/post-receive-hooks/
Note: Post-Receive Hooks looses timezone information