I'll make sure to note stuff down in those pages, then.
Currently, I'm working on the very basics of setting up at Open Uru. Beyond pulling from Mercurial, though, I won't be authoritive on what else you can do, how to get code up for review, etc. I'm hoping that an OU person will step in at that point and basically explain the other stuff.
I'm hoping that the page will include brief introductions into everything, including where you need to have accounts signed up, where those accounts are needed, how to pull code and how to commit code/get code up for review, what the various Foundry things do (Jira and Fisheye especially), and maybe get as far as blogs and whatnot.
(For the record, I do like a lot of the Mercurial features. It's nice to write a tutorial for it.
)
Here is what I have so far. Comments? I'm done working on this for the evening, as I'm going to go onto MOULa and chat to people and also work on Llantern, so anyone can throw this up on the wiki with formatting or add extra content.
Code: Select all
Getting started at Open Uru
(Note: All external links were valid 16/04/2011)
Firstly, you will need to get the Foundry certificate installed into your browser. You can do this here: http://wiki.openuru.org/index.php?title=Foundry_Certificate_Installation
Now, you need a Foundry account. The Foundry account system is centred around JIRA, so you need to sign up there. https://foundry.openuru.org/jira/secure/Dashboard.jspa
Optionally, although highly recommended, you can sign up for a Open Uru forum account here: http://forums.openuru.org/ucp.php?mode=register&sid=b3552cbd54d683118ef596c16cae1b63
Getting a forums account allows you to post on the OpenUru forums, as well as edit the wiki. Currently, you should not use an underscore in your forum username if you wish to edit the wiki due to a bug which will prohibit you from logging into the wiki with a name like Nye_Sigismund or Mac_Fife. Due to the large volume of forum spammers, forum access currently has to be manually authorised.
Using Mercurial to get the code
Open Uru uses Mercurial to manage the codebase. Non-Windows users can get Mercurial here: http://mercurial.selenic.com/wiki/Download. Windows users will want to instead get TortoiseHg, which integrates Mercurial into Windows nicely. http://tortoisehg.bitbucket.org/ This guide will assume that you will use TortoiseHg, however there are tutorials on the Mercurial website for using Mercurial from a command line.
Packages for Linux, BSD and Solaris can be downloaded from the following system-specific repositories.
# Debian/Ubuntu
$ apt-get install mercurial
# Fedora
$ yum install mercurial
# Gentoo
$ emerge mercurial
# FreeBSD
$ cd /usr/ports/devel/mercurial
$ make install
# Solaris 11 Express
$ pkg install SUNWmercurial
On Windows:
Once Mercurial is installed, boot up the TortoiseHg Workbench program.
The first thing you will want to do in Mercurial is give yourself a name, so that if you commit code to the project you can call yourself whatever you like in doing so. To do this, go to File, Settings, Commit. In the top text field, called Author Colouring, fill in a name, and optionally an email address. The format for this should be something like Nye Morgan <whatdoyousee@iseethecleft.com>. Ideally, you should use your JIRA username instead of a real-life name, mostly because it will cause a lot less confusion down the pipeline!
Following this, you need to create a new repository that you will fill with the code you pull from OpenUru. To do this, go to File, New Repository. Find a suitable folder, or create one, and then click Create. Now we have a repository, but it's empty. To get the code, we need to pull from the remote repository where it currently sits. After creating your new repository, it may not be open to be interacted with – you can open it by double-clicking on the name of the repository on the left of the screen.
Now, it's time to get that code! Click on the synchronise button (it's the one with the two arrows in a circle). Now, you need to put in the details of the Mercurial repository you will be pulling from. In this guide, we're going to pull the CWE repository, which is the repository for the Max plugin and the Plasma engine. It's located at https://foundry.openuru.org/hg/CWE . In the “Remote Repository”
area, click on the drop-down box and select “https”. Then, input foundry.openuru.org/hg/CWE (note – do not include the https:// here) into the first text field after the padlock button. Click on the padlock button, and a window will appear. In the “Secure HTTPS Connection” area, select “Verified with stored host fingerprint (good)”. Then click the query button, and the fingerprint should appear in the text field. Then, under “User Authentication”, input your JIRA username and password, making sure that your username is in lower-case. Alternatively, if you don't have a JIRA account, enter “guest” into both the username and password fields. Click “save” at the bottom of the window. Now, you need to clone the repository. To do this, go to File, Clone Repository. Enter the repository's URL (in this example, https://foundry.openuru.org/hg/CWE) into the “Source:” text field. Next, select a new, empty folder for the clone to download to. If all goes well, when you hit “Clone” the files should begin downloading from the repository. Once done, you will probably want to clone the code over to a separate local repository so that you can work on code whilst still having direct reference access to what's actually on the repository. Local clones can be done in the same way as cloning from a remote server, except you clone from a local repository instead.
JIRA: What on Earth/D'ni is it?
JIRA is the powerful project management tool that Open Uru uses. JIRA has a very extensive set of documents detailing what it does, which you can find here: http://confluence.atlassian.com/display/JIRA043/JIRA+User%27s+Guide It is a large amount of documentation, though, so here's what it is and how you can use it in brief.
You can find OpenUru's JIRA at https://foundry.openuru.org/jira/secure/Dashboard.jspa. As with much of the rest of OpenUru's secure areas of the website, you will need to have the Foundry certificate installed in your browser to avoid having warning messages pop up every time you attempt to access the secure areas (see the top of this page for more details).