Getting started with Maemo Garage

m (License: add OSI license information)
(Undo revision 46579 by 125.62.193.58 (Talk) vandalism)
(13 intermediate revisions not shown)
Line 10: Line 10:
* Bugtracker
* Bugtracker
** Also includes a patch tracker, support tracker and feature request tracker
** Also includes a patch tracker, support tracker and feature request tracker
-
* Subversion hosting ([[Git_For_Garage|Git]] available on request)
+
* Subversion hosting ([[Git_For_Garage|Git]] available [[Git_For_Garage#Requesting Git for your Garage project |on request]])
** Web-based repository browsing
** Web-based repository browsing
* Project file hosting (binary and source release archives)
* Project file hosting (binary and source release archives)
Line 19: Line 19:
=== Registering a Garage account ===
=== Registering a Garage account ===
-
To create a Garage project you must have a Garage user account. The [https://garage.maemo.org/account/register.php Garage user registration page] can be found at the top of the [https://garage.maemo.org/ Garages home page].
+
To create a Garage project you must have a Garage user account. The [https://garage.maemo.org/account/register.php Garage user registration page] can be found at the top of the [https://garage.maemo.org/ Garage home page].
=== Registering a project ===
=== Registering a project ===
Line 27: Line 27:
The list below shows requirements of a Garage project. You may be sucessful in acquiring project space if you remember the text on the [https://garage.maemo.org/ Garage home page], ‘This site is meant for hosting various software projects related to the maemo developer platform.’  Each project must determine these settings for themselves.
The list below shows requirements of a Garage project. You may be sucessful in acquiring project space if you remember the text on the [https://garage.maemo.org/ Garage home page], ‘This site is meant for hosting various software projects related to the maemo developer platform.’  Each project must determine these settings for themselves.
<!-- this list is unhelpful and should be removed, or moved to a sub-page (amigadave) -->
<!-- this list is unhelpful and should be removed, or moved to a sub-page (amigadave) -->
-
==== Project Purpose And Summarization ====
+
==== Project purpose and summary ====
-
The project purpose is perhaps one of the most important items on the list of requirements. This statement says what you plan to do. The site administrator will approve your project primarily based on this statement. Remember that the admins are looking to see if your goal matches their intent of the site. Test projects will not be approved. You can either download a copy of the gForge software or try one of their demo sites.
+
The project purpose is perhaps one of the most important items on the list of requirements. The site administrator will approve your project primarily based on this statement.
==== License ====
==== License ====
Line 37: Line 37:
==== Project Public Description ====
==== Project Public Description ====
-
Your project public description is your first communication with users. Please pick it accordingly with a marketing hat on your head. However, don't let it stop progress if you cannot think of something clearly that describes your project. It can be revised later.
+
Your project public description is your first communication with users, and so it is important to offer a concise outline of the project. However, the description can be revised at a later time.
==== Project Unix Name ====
==== Project Unix Name ====
-
The final requirement is what name will you use to plant your project on the Garage servers? This name will be used in many tools and URLs, such as the project information page at <nowiki>https://garage.maemo.org/projects/unixprojectname</nowiki>, where ''unixprojectname'' is relaced with the selected name.
+
The final requirement is the name that will be used for your project on the Garage servers. This name will be used in many tools and URLs, such as the project information page at <nowiki>https://garage.maemo.org/projects/unixprojectname</nowiki>, where ''unixprojectname'' is replaced with the selected name.
== Working with Subversion ==
== Working with Subversion ==
Line 50: Line 50:
== Creating a website ==
== Creating a website ==
-
To use Garage’s website hosting, a <code>www</code> directory containing a static website must be added as a toplevel directory in the Subversion (or Git) repository of the project. The index page should be named <code>index.html</code>, and be placed in the <code>www</code> directory. Changes to a project website must be made to the source code repository, like any source code changes, but are only visible on the project website after a delay of several minutes. A project website can be accessed from the project information page.
+
To use Garage’s website hosting, a <code>www</code> directory containing a static website must be added as a toplevel directory in the Subversion (or Git) repository of the project. The index page should be named <code>index.html</code>, and be placed in the <code>www</code> directory. Changes to a project website must be made to the source code repository, like any source code changes, but are only visible on the project website after a [http://lists.maemo.org/pipermail/maemo-developers/2009-March/018717.html delay of upto 20 minutes]. A project website can be accessed from the project information page.
== Trackers and tasks ==
== Trackers and tasks ==
Line 62: Line 62:
== External resources ==
== External resources ==
-
* [http://gforge.org/ gForge] the project hosting software use by Garage
+
* [http://gforge.org/ gForge] the project hosting software used by Garage
* [http://svnbook.red-bean.com/ Version control with Subversion book] a free online Subversion book, also available in print
* [http://svnbook.red-bean.com/ Version control with Subversion book] a free online Subversion book, also available in print
* [http://tortoisesvn.tigris.org/ TortoiseSVN] a Windows SVN client
* [http://tortoisesvn.tigris.org/ TortoiseSVN] a Windows SVN client
-
 
[[Category:Development]]
[[Category:Development]]

Revision as of 13:35, 11 February 2012

See Task:Using_garage.maemo.org

Contents

About Garage

Garage is a software hosting platform for Maemo-related projects.

Services provided by Garage

  • Website hosting
  • Bugtracker
    • Also includes a patch tracker, support tracker and feature request tracker
  • Subversion hosting (Git available on request)
    • Web-based repository browsing
  • Project file hosting (binary and source release archives)
    • Ability to track number of downloads

Creating a Garage project

Registering a Garage account

To create a Garage project you must have a Garage user account. The Garage user registration page can be found at the top of the Garage home page.

Registering a project

The second step, after logging in, is to register a project. You will find this link at the top of your developer's home page.

The list below shows requirements of a Garage project. You may be sucessful in acquiring project space if you remember the text on the Garage home page, ‘This site is meant for hosting various software projects related to the maemo developer platform.’ Each project must determine these settings for themselves.

Project purpose and summary

The project purpose is perhaps one of the most important items on the list of requirements. The site administrator will approve your project primarily based on this statement.

License

Your project must have an open source license. Some suitable licenses are listed by the Open Source Initiative.

Project Public Description

Your project public description is your first communication with users, and so it is important to offer a concise outline of the project. However, the description can be revised at a later time.

Project Unix Name

The final requirement is the name that will be used for your project on the Garage servers. This name will be used in many tools and URLs, such as the project information page at https://garage.maemo.org/projects/unixprojectname, where unixprojectname is replaced with the selected name.

Working with Subversion

Main article: Subversion


Creating a website

To use Garage’s website hosting, a www directory containing a static website must be added as a toplevel directory in the Subversion (or Git) repository of the project. The index page should be named index.html, and be placed in the www directory. Changes to a project website must be made to the source code repository, like any source code changes, but are only visible on the project website after a delay of upto 20 minutes. A project website can be accessed from the project information page.

Trackers and tasks

Trackers are provided for management of bugs, feature requests, patches and support discussion. A ‘Tracker’ link is available from the project information page if the tracker is enabled for a project. As an alternative to the Garage tracker, it is possible for a Garage project that has been uploaded to Extras to request a component in maemo.org Bugzilla.

Making releases

Source code and binary releases can be distributed with Garage with the ‘File’ link from the project information page. A release can be made with a changelog and release notes, so that users may read this information without having to download a release in full. A download count is provided for each release. Rather than distributing binary packages through Garage, it is recomended to upload packages to Extras to get the widest exposure and to make installation easier for users.

External resources