<!DOCTYPE html>
<html>
<head>
<title>OSP Documentation</title>
<link rel="stylesheet" type="text/css" href="docs_style.css">
</head>
<body>
<div id="site-header">
<div class="wrapper">
<a href="http://opensourceprojects.eu" id="header-logo"><img src="logo.png"></a>
</div>
</div>
<div id="content_base">
<h1>OSP Documentation</h1>
<h2>Setting up your Account</h2>
<img src="img/account.png"/>
<p>
To start using the platform you require a user account. You can create one
from the front page. Fill in your preferred display name, user name and
email address. You will soon receive an email with activation link and
your password. Activate your account by clicking the link and following
the instructions given. Now you can start working on the platform.
</p>
<p>
To login with your existing account, click the top left corner
login-link and insert your username and password.
</p>
<h2>Project Management</h2>
<p>You can create new projects from the projects list (from the top menu under <b>Projects</b>)
This opens a list of projects available to you. To create one of your
own, click the <b>Add a Project</b> button from the left side menu.
This opens the project creation page.
</p>
<img src="img/createproject.png" class="narrow"/>
<p>
From this page you can select the name of the project, and some of the initial project settings:
</p>
<ul>
<li>Project Name(3-15 characters long</li>
<li>Project URL name, http://opensourceproject.eu/p/<b>url-name</b></li>
<li>The tools that will be enabled for this project</li>
<li>Whether the project is private or not</li>
</ul>
<p>
With exception to the project name/url all these settings can be added at a later time. After creating you new project, you will be redirected to the project administration page.
</p>
<h3>Installing new Tools</h3>
<p>
You can install new tools in your project from the <b>Admin/ Tools</b>
and clicking on the tool you want to install. The new instance will
need a Label (that shows up in the sidebar), and a Mount point (a path
in the URL)
</p>
<img src="img/itickets.png"/>
<h3>Creating subprojects</h3>
<p>
Sub projects are a common part of large projects that require
maintaining several tools and source code under a common group, such as
an ICT project. You can create sub-projects under the <b>Admin/ Tools</b>
selection.
</p>
<p>
You will be given two choices to create a sub-project: associate a sibling
project or create a new project as sub-project of the main one.
To achieve either of available options, it is necessary to navigate to
the main project's tools page
</p>
<p class="hint">Projects > ProjectName > Admin > Tools</p>
<p>and click to add a new Subproject tool. A form will pop up for you
to fill in the sub-project's information, such as its Label and its
Mount Point. The platform checks if the mount point already exists and
either associates the existing point as the main one, or creates a new
project with the specified title in Label and URL name. This
information is saved with the save button.</p>
<p>After the pop-up window is dismissed, the new Subproject tool will
be listed along with the other installed tools.</p>
<h2>Git</h2>
<h2>SVN</h2>
<h2>Issue Tracker</h2>
<div class="col1">
<p>
Issue management is available on the platform as one of the more important
tools. It directly supports the development process and tickets allow the users
and developers to interact with the project maintainers and main developers. In
this section you get a rough overview of how tickets are configured in a
specific project and how end-users can take advantage of them.
</p>
<p>
Tickets are specific items that correspond to problems identified in the
software, missing features requested by end users, or general communication
items between developers and users. In many tools they are also known as
���issues��� or ���bugs���, and hence the name of issue or bug trackers.
</p>
<p>
The ticket tracker tool is designed to allow for flexibility in how you track
items of work that need to be completed. This includes bugs, feature requests
from end users, or any other task you want to keep track of. You can even
install multiple ticket trackers for different purposes. For example, a large
project could have individual trackers for the design team, the documentation
team, the developers, and another for support. Each of these trackers can have
their own unique list of tickets, as well as custom fields, custom milestones,
and their own "mailing list." Tickets can even be moved between tickets
instances, even if they're on different projects.
</p>
</div>
<div class="col2">
<img src="img/feature-tickets.png"/>
</div>
<h3>Installing the Issue Tracker</h3>
<p class="col1">
You can install a new issue tracker instance from the <b>Admin/ Tools</b> and
clicking on the <b>Tickets</b> tool. The new instance that will need a Label (that shows up in the sidebar), and a Mount point (a path in the URL)
</p>
<p class="nocol">
After the tool is installed, you should see a new tool in the
<b>Tools</b> page and in the project sidebar.
Once installed, some configuration options become available in the Tool page.
</p>
<ul>
<li>Field Management
<ul>
<li>Allows administrators to configure how the fields in the ticket tracker appear.</li>
<li>There are several fields you can select from, that are most well suited for your project needs.</li>
</ul>
</li>
<li>Edit Searches
<ul>
<li>If you have a search that you want all users of the tracker to be able to share, you can save that search with a name and it will be placed in the left navigation bar of the tracker for everybody to use.</li>
<li>You can use these saved searches to watch the flow of tickets through the system and make it easier for your development team to focus on groups of active tickets.</li>
</ul></li>
<li>Permissions - Allows you to define the permissions for viewing and resolving tickets.
</li>
<li>Options
<ul>
<li>The default behavior of the Tickets tool can be modified here</li>
<li>Allows for voting tickets up/down, email notifications, and setting up customized help texts</li>
</ul>
</li>
</ul>
<h3>Using the issue tracker</h3>
<p>
With the appropriate permissions, users can create a new ticket using
the Create Ticket link in the left sidebar. At the new ticket form,
fill in a title, and any other appropriate fields, and an issue
description. To edit the main ticket description or fields on an
existing ticket, providing you have the permissions to do so, select
the EDIT button in the upper right of a ticket. If further discussion
about a ticket is needed, use the comment field at the bottom.
</p>
<p>
You can also move and delete tickets. This again depends on your
permissions on the particular instance.�� To move a ticket, select the
Move option in the upper right of the ticket view. To delete a ticket,
select the Trash Can icon in the upper right of the ticket view. This
ticket will now be "deleted", however it may still be "undeleted" if
you select the + icon which replaces the Trash Can icon. If a deleted
ticket matches a list view, there will be a "Show deleted tickets" link
which will allow you to see them.
</p>
<p>
Searching a ticket is also possible. The search uses Solr Lucene query
syntax. On any search page you will see a Help button that will show
the different searches available and some exact examples.
</p>
<h2 class="nocol">Wiki</h2>
<p>The wiki is a collaborative document editor which is easily edited
and can be used for various documentation needs, both internal and
external. By default any project developer can edit the project wiki,
but permissions can be regulated as you wish them to be available to
different user groups. Like most modern wikis, all edits are
non-destructive and a copy of every version is stored.</p>
<h2 class="nocol">Forum</h2>
<h2 class="nocol">Blog</h2>
<p>
The blog may be installed through the tools menu, as described before,
by adding the corresponding tool in the administration area via Admin -
Tools. Once installed, there are a number of configuration options
available for each Blog. In addition to the common tool options of
permissions, Label and Delete, you can determine an external feed.
These external feeds may be updated every three hours and add posts to
the blog accordingly. Multiple feeds may be added, which can serve to
aggregate related news about the project. Unchecking a feed will remove
it from the list.
</p>
<p>
To create a new post, select "New Post" from the left sidebar under the Blog option. Enter a title and description for the post and Save to publish the post. If you save a draft for later editing before making it public, change the State to Draft before saving. Select the Edit link to edit a post or saved draft. You may also delete a post from the Edit view.
</p>
<p>
Like all Allura tools, the blog uses Markdown syntax. Each blog post will also have a discussion section for users to comment on the post.</p>
<h2>Metrics and Statistics</h2>
<div class="footer">
</div>
</body>
</html>