User Guide

Registration

Please note that you only need to register and request membership for a project if you need write access on the wiki and repositories. Read access is universal.

Everything on this site is readable by everyone. You will not be able to access more material by registering.

Also, subscribing to the Discourse forums is independent from OHR membership.

If there really is a project that you need to have write access on (and only then), you have to register. After that you should ask the administrator of the project to give you access rights. If you still think you need to register, please contact Javier.Serrano (insert a "@" here) cern.ch by sending a him or one of the other OHWR administrators your Name, Username and E-mail.

Guidelines

Wiki editing

Redmine uses a language called "textile" for wiki editing.

This page explains the most used commands, as well as several modifications to textile introduced on redmine, such as links to issues and commits:

/help/wiki_syntax_detailed

For a complete textile reference, see the textile reference manual for redcloth (the library used for rendering textile on this page).

If you are familiar with Twiki, you may want to read the twiki-vs-textile page in order to see the differences.


Repositories

The repositories are used to store full hardware design information and source files of firmware and software. Someone who likes to continue a development should be able to check out a Repository and have all needed information. Here are a couple of example policies currently used in OHR projects for handling contributions:

SVN repositories

When you enter the repository page of one project, you should now see a "Checkout URL" link near the top-right corner of the page (You may find a sample of that url on the OHR Support repository page )

If the link isn't showing, then the project administrator has configured it so it doesn't show. Please contact your project administrator in that case.

Once you get hold of the svn repository, you should be able to checkout it.

If you are using linux/unix, you can checkout a repository by using the svn checkout (svn co) command. You will need to have a subversion client installed on your machine.

Here's an example for checking out ohr support's repository:

svn co http://svn.ohwr.org/ohr-support/

If you are using windows, you will need a svn client, too. We recommend tortoiseSVN for windows users, although there are other options.

If you have developer access to the project, you will be able to do commits to its repository by using your ohwr.org username and password. Otherwise, you will have read-only access. Please contact your project manager if you need developer access.

Git repositories

Much like with the SVN repositories, the Git repositories are available to everyone on read-only mode. There's a difference, though; git repositories have two URLs; one for read-only access and another one for read-write.

If you want to clone a git repository in read-only mode, you have to use a command like the following:

git clone git:https://www.ohwr.org/white-rabbit/wr-switch-sw.git

(Notice that we are using the white-rabbit/wr-switch-sw project for this example. You may get the correct url from your project's repository page)

The only requisite for cloning a repository this way is that you have git installed and configured on your machine.

Read/write access has more requirements.

You may browse the Git-Client-Setup page for instructions about how to install & configure Git.

Once the previous requirements are met, you will be able to clone the repository by executing a command similar to this one:

git clone git@ohwr.org:white-rabbit/wr-switch-sw.git

Notice that the syntax is slighly different from the read-only version, and that we are again using white-rabbit/wr-switch-sw as an example.

Other info


28 August 2019