How to use this site¶
- How to use this site
There are multiple projects on this site. Generally, each project on the site corresponds to a unique open-source software project. Each project contains an issue tracker and a wiki. Some may also contain other modules, such as forums, documents, and news.
You can view a list of projects here. On desktop, this link is found at the top of any page on the site ("Projects"). On mobile, it is found by clicking the menu icon on the top right of the page and scrolling to the "General" section.
You can also use the "Jump to project" feature to quickly switch between projects. On desktop, this is found in a dropdown menu at the top of the page, next to the search bar. On mobile, it is found by clicking the project name on the top banner.
An account is needed for any features that require "write" permissions, such as filing issues, adding comments, or editing wiki pages. Your account must be manually approved for your activity to be visible to other users. These restrictions are in place to prevent spam and abuse.
Registering an account¶
- Go to the registration page. A link to the registration page is found on the top right of any page on desktop, and in the navigation menu on mobile.
- Fill in all of the required details. All of your account details, including your name and username (or "login"), can be changed after creating your account.
Regarding "first" and "last" names¶
We apologize for requiring "first" and "last" names upon account registration. This rather strange requirement comes from the Redmine software we're using. We're aware that many people have names that do not fit this model, or are simply not comfortable giving their last names.
We have configured the site such that only Administrators and Managers can see your first and last names, and only through the admin panel; every other page will display your username instead. Feel free to use a placeholder (e.g., "Redmine User").
- Non-member: the default level upon registration. Non-members can post issues and comments, but other users will not see them until they are approved by a Manager or Administrator.
- Contributor: can post public or private issues and comments, and can edit wikis.
- Manager: all of the privileges of Contributor status, plus the ability to assign issues, edit existing issues and comments, post documents, and modify user privileges.
- Administrator: total control over the site.
You can browse through issues by navigating to a project (see "Projects" above), then clicking on the "Issues" tab.
You can filter issues (e.g., by status, assignee) by clicking on the "Filters" option, or by clicking on one of the custom queries in the sidebar. You can also search for issues by using the "Search" feature (see "Search" below).
Edit an issue¶
If you have the right permissions, you can edit an issue by right-clicking on it on the issues list and clicking "Edit" on the context menu. This will take you to the issue editing page.
You can also go to the issue editor by clicking on the issue to be taken to the issue page. From here, click "Edit".
Commenting on an issue¶
To leave a note on an issue, go to the issue editor (see "Edit an issue" above), fill out the "Notes" field, and press "Submit".
Creating an issue¶
If you have the right permissions, you can file an issue by navigating to a project, then clicking on the "New Issue" tab.
The Search feature allows you to search for issues, documents, forum posts, and wiki pages throughout the entire site. On desktop, the Search field is found on the top right of any page. On mobile, it is found at the top of the navigation menu.
You can do a basic search by simply typing your query into the search field and pressing enter. You can go to the advanced search page by clicking on the "Search" link on desktop; you will also be taken there automatically upon performing a basic search.