Getting started with Maemo Garage
m (Reverted edits by 49.36.189.40 (Talk) to last revision by joerg_rw) |
|||
Line 1: | Line 1: | ||
- | + | See [[Task:Using_garage.maemo.org]] | |
- | + | == 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_For_Garage|Git]] available [[Git_For_Garage#Requesting Git for your Garage project |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 [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 === | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | The second step, after logging in, is to [https://garage.maemo.org/register/ register a project]. You will find this link at the [https://garage.maemo.org/my/ 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 [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) --> | |
- | + | ==== 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 [http://opensource.org/licenses/category 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 <nowiki>https://garage.maemo.org/projects/unixprojectname</nowiki>, where ''unixprojectname'' is replaced with the selected name. | |
- | + | ||
- | + | == Working with Subversion == | |
- | + | ||
+ | {{main|Subversion}} | ||
+ | <!-- More to come --> | ||
+ | |||
+ | == 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 [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 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 [[Bugs:Adding_Extra_products|request a component]] in [https://bugs.maemo.org/ 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 == | ||
+ | |||
+ | * [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://tortoisesvn.tigris.org/ TortoiseSVN] a Windows SVN client | ||
+ | [[Category:Development]] |
Revision as of 12:08, 17 December 2022
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
- gForge the project hosting software used by Garage
- Version control with Subversion book a free online Subversion book, also available in print
- TortoiseSVN a Windows SVN client