Skip to content

Commit

Permalink
Fixes #9818, #9819 - documentation for changelog / roadmap changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@vboctor
vboctor committed Nov 19, 2008
1 parent da50c6e commit badc584
Showing 1 changed file with 62 additions and 8 deletions.
70 changes: 62 additions & 8 deletions docbook/adminguide/en/project_management.sgml
View file
Expand Up @@ -56,10 +56,37 @@ function custom_function_override_changelog_print_issue( $p_issue_id, $p_issue_l

<para>In some cases, users know that they fixed an issue and that the fix will be included in the next release, however, they don't know yet the name of the release. In such case, the recommended approach is to always have a version defined that corresponds to the next release, which is typicalled called 'Next Release'. Once the release is cut and has a concrete name, then 'Next Release' can be renamed to the appropriate name and a new 'Next Release' can then be created. For teams that manage releases from multiple branches for the same project, then more than one next release can be possible. For example, 'Next Dev Release' and 'Next Stable Release'.</para>

<para>Another common requirement is to be able to link to the change log of a specific project from the project's main website. This can be done by a link that looks like the one below. The project id can be figured out by going to the management page for the project and getting the value of project_id field form the URL.
<programlisting>
http://www.example.com/mantisbt/changelog_page.php?project_id=1
</programlisting>
<para>Another common requirement is to be able to link to the change log of a specific project from the project's main website. There is a variety of ways to do that:
<itemizedlist>
<listitem>
<para>To link to the changelog of version "ver1" of project "myproject":
<programlisting>
http://www.example.com/mantisbt/changelog_page.php?project=myproject&amp;version=ver1
</programlisting>
</para>
</listitem>
<listitem>
<para>To link to the changelog of all non-obsolete versions of project 'myproject':
<programlisting>
http://www.example.com/mantisbt/changelog_page.php?project=myproject
</programlisting>
</para>
</listitem>
<listitem>
<para>To link to the changelog of project with id 1. The project id can be figured out by going to the management page for the project and getting the value of project_id field form the URL.
<programlisting>
http://www.example.com/mantisbt/changelog_page.php?project_id=1
</programlisting>
</para>
</listitem>
<listitem>
<para>To link to the changelog of version with id 1. The version id is unique accross all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
<programlisting>
http://www.example.com/mantisbt/changelog_page.php?version_id=1
</programlisting>
</para>
</listitem>
</itemizedlist>
</para>

<para>Another approach is to go to the project page and from there users can get to multiple other locations relating to the project include the change log. This can be done by a URL like the following:
Expand Down Expand Up @@ -133,10 +160,37 @@ function custom_function_override_roadmap_print_issue( $p_issue_id, $p_issue_lev
Some teams manage different branches for each of their projects (e.g. development and maintenance branches). As part of triaging the issue, they may decide that an issue should be targetted to multiple branches. Hence, frequently the request comes up to be able to target a single issue to multiple releases. The current MantisBT approach is that an issues represents an implementation or a fix for an issue on a specific branch. Since sometimes applying and verifying a fix to the two branches does not happen at the same time and in some cases the approach for fixing an issue is different based on the branch. Hence, the way to manage such scenario is to have the main issue for the initial fix and have related issues which capture the work relating to applying the fix to other branches. The issues for porting the fix can contain any discussions relating to progress, reflect the appropriate status and can go through the standard workflow process independent of the original issues.
</para>

<para>Another common requirement is to be able to link to the roadmap of a specific project from the project's main website. This can be done by a link that looks like the one below. The project id can be figured out by going to the management page for the project and getting the value of project_id field form the URL.
<programlisting>
http://www.example.com/mantisbt/roadmap_page.php?project_id=1
</programlisting>
<para>Another common requirement is to be able to link to the roadmap of a specific project from the project's main website. There is a variety of ways to do that:
<itemizedlist>
<listitem>
<para>To link to the roadmap of version "ver1" of project "myproject":
<programlisting>
http://www.example.com/mantisbt/roadmap_page.php?project=myproject&amp;version=ver1
</programlisting>
</para>
</listitem>
<listitem>
<para>To link to the roadmap of all non-obsolete versions of project 'myproject':
<programlisting>
http://www.example.com/mantisbt/roadmap_page.php?project=myproject
</programlisting>
</para>
</listitem>
<listitem>
<para>To link to the roadmap of project with id 1. The project id can be figured out by going to the management page for the project and getting the value of project_id field form the URL.
<programlisting>
http://www.example.com/mantisbt/roadmap_page.php?project_id=1
</programlisting>
</para>
</listitem>
<listitem>
<para>To link to the roadmap of version with id 1. The version id is unique accross all projects and hence in this case it is not necessary to include the project id/name. The version id can be figured out by going to the manage project page and editing the required version. The version_id will be included in the URL.
<programlisting>
http://www.example.com/mantisbt/roadmap_page.php?version_id=1
</programlisting>
</para>
</listitem>
</itemizedlist>
</para>

<para>Another approach is to go to the project page and from there users can get to multiple other locations relating to the project include the roadmap. This can be done by a URL like the following:
Expand Down

0 comments on commit badc584

Please sign in to comment.