Please help strengthen our documentation by rating items on how helpful they are, and by suggesting documentation, that we are missing and should focus on next.
posted on 19:03 - 22 June 2009 | posted by Lev
Setting up a bug tracker isn't done with a simple button, but you'll find it isn't that hard (and is actually better for being advanced) once you know how to do it.
The first thing is creating an issue tracking project. Each issue tracking project has its own statuses and versions, so creating the issue tracking project is the first thing you should do. Because the issue tracking module fully supports the language pack feature of Theia, this means that each project can have a different name in each language. For this reason, creating an issue tracking project is done in the "language management" tools and NOT under "section management tools" as you might first think.
Click "tools" and scroll down to the "language management" area, and then look for the link reading "manage issue tracking projects" (admin tool 145). Click this option, and look at the lower table. Unless you have multiple language packs installed, you only need to fill in the "name" field; for example, "bug tracker".
After the issue tracking project has been added successfully, go back to the tools page and look, once again, under the "language management" tools for a tool reading "manage issue tracking versions" (admin tool 146). On this page, you may want to enter several versions (one at a time). Each version becomes a selectable option when users create items for issue tracking sections associated with the project. Assuming you only have one language pack, and one issue tracking project, all you will need to fill in here is the "name" field. For example, write in "1.0", and submit the form. Do it again and enter "2.0".
And last of all (in terms of adding language options at least) is adding some issue tracking statuses. Again, look under "language management" (on tools) for "manage issue tracking statuses" (admin tool 147). Click the link and scroll to the lower table. Assuming only one language pack is installed, and assuming only one issue tracking project exists, only the "name" field needs to be filled in here too. For example, write in "confirmed" and submit the form. Then you could write in "fixed" and submit the form (you get the idea).
After you've created at least one issue tracking project, as well as at least one version and one status associated with that project, then you will finally want to associate this project with a section. For this, look under "section management" for the link reading "associate section with issue tracking projects" (admin tool 178). Click this link, and then select the section you want to associate the project with. The instructions are very simple, quick and straightforward. Any section can be associated with any number of issue tracking projects (or simply one).
Last, but definitely not least, you need to make sure the section is using the "issue tracking" mode type. Under "section management" look for "modify a section" (admin tool 002), and click this link. Again, choose the section from the selection menu and process the form to manage the section. Look for the "mode type" field and make sure it is set to "issue tracker". Save the form. Now, if you look below where the "mode type" field is, you will see a new field reading "default issue status ID". Set this field to the ID of a status that all new items created in that section will take on at the moment of creation. For example, if you have a status named "pending investigation" and its ID is 3, then write in 3 for the "default issue status ID" field. To get the status's ID, just view the "manage issue tracking statuses" page (admin tool 147).
The reason this procedure takes as many steps as it does is because the system is designed to be flexible enough to be used for many different scenarios (even at the same time).
For example, you could have one section which has a project that operates as a bug tracker (with its own unique statuses and versions), and at the same time you could have another section which has a project that operates as a feature request area (with its own unique statuses and versions as well). Or, you could use the issue tracker system as a support/ticket system, so statuses could reflect the status of the support request. I'm sure you get the idea, and realize that by leaving it as vague as possible, using the issue tracker system could be used in countless ways!
The first thing is creating an issue tracking project. Each issue tracking project has its own statuses and versions, so creating the issue tracking project is the first thing you should do. Because the issue tracking module fully supports the language pack feature of Theia, this means that each project can have a different name in each language. For this reason, creating an issue tracking project is done in the "language management" tools and NOT under "section management tools" as you might first think.
Click "tools" and scroll down to the "language management" area, and then look for the link reading "manage issue tracking projects" (admin tool 145). Click this option, and look at the lower table. Unless you have multiple language packs installed, you only need to fill in the "name" field; for example, "bug tracker".
After the issue tracking project has been added successfully, go back to the tools page and look, once again, under the "language management" tools for a tool reading "manage issue tracking versions" (admin tool 146). On this page, you may want to enter several versions (one at a time). Each version becomes a selectable option when users create items for issue tracking sections associated with the project. Assuming you only have one language pack, and one issue tracking project, all you will need to fill in here is the "name" field. For example, write in "1.0", and submit the form. Do it again and enter "2.0".
And last of all (in terms of adding language options at least) is adding some issue tracking statuses. Again, look under "language management" (on tools) for "manage issue tracking statuses" (admin tool 147). Click the link and scroll to the lower table. Assuming only one language pack is installed, and assuming only one issue tracking project exists, only the "name" field needs to be filled in here too. For example, write in "confirmed" and submit the form. Then you could write in "fixed" and submit the form (you get the idea).
After you've created at least one issue tracking project, as well as at least one version and one status associated with that project, then you will finally want to associate this project with a section. For this, look under "section management" for the link reading "associate section with issue tracking projects" (admin tool 178). Click this link, and then select the section you want to associate the project with. The instructions are very simple, quick and straightforward. Any section can be associated with any number of issue tracking projects (or simply one).
Last, but definitely not least, you need to make sure the section is using the "issue tracking" mode type. Under "section management" look for "modify a section" (admin tool 002), and click this link. Again, choose the section from the selection menu and process the form to manage the section. Look for the "mode type" field and make sure it is set to "issue tracker". Save the form. Now, if you look below where the "mode type" field is, you will see a new field reading "default issue status ID". Set this field to the ID of a status that all new items created in that section will take on at the moment of creation. For example, if you have a status named "pending investigation" and its ID is 3, then write in 3 for the "default issue status ID" field. To get the status's ID, just view the "manage issue tracking statuses" page (admin tool 147).
The reason this procedure takes as many steps as it does is because the system is designed to be flexible enough to be used for many different scenarios (even at the same time).
For example, you could have one section which has a project that operates as a bug tracker (with its own unique statuses and versions), and at the same time you could have another section which has a project that operates as a feature request area (with its own unique statuses and versions as well). Or, you could use the issue tracker system as a support/ticket system, so statuses could reflect the status of the support request. I'm sure you get the idea, and realize that by leaving it as vague as possible, using the issue tracker system could be used in countless ways!
Bookmark item @
