Differences

This shows you the differences between two versions of the page.

--- googlecodein:gettingstarted [2011/11/27 18:17] – GavinAtkinson
+++ googlecodein:gettingstarted [2020/12/30 02:52] (current) – Remove 1 broken hyperlink. SashaVigole
@@ Line 4: / Line 4: @@
 If you have any problems with any of the instructions here, please do feel free to talk to your mentor, or ask on IRC.  There are many mentors available in #freebsd-soc on EFnet, feel free to pop in and say hello even if you are not having issues!
+===== Requirements for Google Code-In tasks =====
+Most of the Google Code-In tasks require the following:
+  * A %%FreeBSD%% system (in a [[/VirtualBox|VirtualBox]] Virtual Machine) installed on your computer.  A pre-prepared image along with instructions for use can be found below.  It is recommended that students new to %%FreeBSD%% use this pre-prepared image.
+  * Knowledge of the documentation guidelines for the %%FreeBSD%% project: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/
+  * A copy of the %%FreeBSD%% documentation tree checked out from the %%FreeBSD%% doc repository.  The pre-prepared VM image already contains this, or see below for details on how to obtain this.
+  * Knowledge on how to research information on the internet
+  * Thorough work style
 ===== Using the pre-prepared VM images =====
-The easiest way to get started with the Google Code-In tasks is to download the pre-made Virtual Machine image.  This is available from http://people.FreeBSD.org/~gavin/FreeBSD9.0_GCIN.ova (2.2Gb download, SHA256 aa212d1ca717a6a9800e67462ec3456c5e652fea1bba09bb649d6fa3cb0c6ea6).  It is known to work with [[/VirtualBox|VirtualBox]] 4, but should also work with minimal effort on anything supporting the OVF format for virtual machine images, including VMware.
+The easiest way to get started with the Google Code-In tasks is to download the pre-made Virtual Machine image.  This is available for download from ''%%people.FreeBSD.org/~gavin/FreeBSD9.0_GCIN.ova%%'' (2.2Gb download, SHA256 aa212d1ca717a6a9800e67462ec3456c5e652fea1bba09bb649d6fa3cb0c6ea6).  It is known to work with [[/VirtualBox|VirtualBox]] 4, but should also work with minimal effort on anything supporting the OVF format for virtual machine images, including VMware.
 Once the VM image has been imported, boot it.  The image has been set up so that all your work can either be done on the VM console itself, or over SSH.  After the machine has booted, basic instructions will be shown on the console, including the IP address that the virtual machine has been given.  You can SSH to this IP address (using the gcin account) if you wish to work over SSH rather than directly on the console.  GNOME is also available in the VM image, should you prefer to use the VM directly.
@@ Line 13: / Line 23: @@
 There are two accounts set up:
-| 'username' | 'password' |
+| username | password |
 | root | gcin |
 | gcin | gcin |
@@ Line 42: / Line 52: @@
 ==== Submitting your work ====
-The preferred format for submitting work done is in diff format.  To produce a diff of your work, us the "svn diff" command.
+The preferred format for submitting work done is in diff format.  To produce a diff of your work, use the "svn diff" command.
 For example, to create a diff of changes made to the %%FreeBSD%% handbook, the following command should be used:
@@ Line 66: / Line 76: @@
 The following assumes that you are using %%FreeBSD%%, either on a real machine, or in a virtual environment, and that your system has Internet access.
-===== Documentation tree =====
+===== Obtaining the FreeBSD Documentation tree =====
 The %%FreeBSD%% Project currently still uses CVS to store its documentation.  In order to make things easier for GCIN students, we have started exporting the doc tree to a Google Code svn repository, which should prove easier for students unfamiliar with CVS to work with.
@@ Line 74: / Line 84: @@
 ''%%svn checkout http://freebsd9-documentation.googlecode.com/svn/branches/gcin2011/doc doc%%''
-==== Testing your changes ====
+Once you have obtained the code, please see the top section of this page for how to work with it, test your work, and submit your changes.
-Once you are ready to test your changes, follow the instructions at ''%%http://www.freebsd.org/doc/en/books/fdp-primer/overview-quick-start.html%%''
+===== Obtaining the FreeBSD source Code =====
-===== FreeBSD source Code =====
 As the %%FreeBSD%% source code is held in SVN, this can be checked out directly:
@@ Line 84: / Line 92: @@
 ''%%svn co svn://svn.freebsd.org/base/head/%%''
-==== Testing your changes ====
+Once you have obtained the code, please see the top section of this page for how to work with it, test your work, and submit your changes.
-(To write)
-===== Submitting your changes =====
-As you made a copy of the file before you made changes, you can produce a diff from it with:
-''%%svn diff doc > /var/tmp/gcin-taskname.diff%%''
-This file can then be submitted to your task mentor(s) during the task, and uploaded to Google Melange once you feel the task is complete.
-Note that this diff will only contain modified files, and not files that have been added.  Any files created from scratch should be uploaded to Google Melange separately.