NFV Issue Tracker: Difference between revisions

From NFVwiki
No edit summary
No edit summary
 
(57 intermediate revisions by 5 users not shown)
Line 1: Line 1:
To report feedback on an ETSI NFV public DRAFT, you may use the '''[http://forge.etsi.org/mantis/view_all_bug_page.php?project_id=153 ETSI Issue Tracker]''' and then select the draft reference on which you want to report an issue or click on the direct link in the table below.
== Login to the Issue Tracker ==
'''Login with EOL:''' NFV members and participants can login to the ETSI NFV Issue Tracker with their '''ETSI Online (EOL) account''' (used to log into the ETSI Portal).
 
Go to the [https://forge.etsi.org/rep/nfv/issues ETSI NFV Issue Tracker] and login.
 
User with '''EOL account''' can view and create issues, but users without EOL account can only view issues.


ETSI NFV public DRAFTS are available in the '''[http://docbox.etsi.org/ISG/NFV/Open/Drafts/ NFV Open Area]'''.
Issue tracker allows normal users to submit new issues and view public issues, but does not allow to process issues.
<small>(this area only contains the ISG NFV drafts which have been made public, i.e. most of them).</small> <br />


Chairs, Vice-Chairs, and Rapporteurs have a "'''Developer'''" or "'''Maintainer'''" role, which additionally allows viewing private issues and processing issues.


== Login to the Issue Tracker ==
[[File:Login bug tracker.png|599x599px]]
'''Login with EOL:''' NFV members and participants can login to the ETSI NFV Issue Tracker with their '''ETSI OnLine (EOL) account''' (used to log into the ETSI Portal).  
 
== View Issues ==
1. Go to the [https://forge.etsi.org/rep/nfv/issues ETSI NFV Issue Tracker] and login.
 
2. To view the list of all issues, click "'''Issues'''" under "'''Pinned'''" drop down button.
 
3. To view issues by '''assignee''', '''author''', or '''label''', click the search bar and choose the relevant option.
 
4. To find issues related to a specific '''specification''', '''version''', or '''other details''', use the '''search bar''' to enter your keywords.
 
[[File:Review issues.png|707x707px]]
 
 
5. To view the details of a specific issue, click title of the issue.


'''Create local account:''' The ETSI NFV Issue Tracker is also open to the general public: creating a local account only requires a username and a valid e-mail address, which is verified in the process.  
[[File:To open existing issue.png|707x707px]]


Connect to the [http://forge.etsi.org/mantis/main_page.php ETSI bug tracker] and login.
=== Else how to navigate to the Issues Repository ===
1. Go to the [https://forge.etsi.org/rep/nfv/ ETSI Forge NFV Group].


New accounts have a "'''Reporter'''" role by default, which allows to submit new issues and view public issues, but not to process issues.
2. Click on the "'''Issues'''" repository.


Chairs, Vice-Chairs, and Rapporteurs have a "'''Developer'''" role, which additionally allows viewing private issues and processing issues.  
[[File:Navigate to issues repo.png|707x707px]]


[[File:login_bug_tracker.png.png|600px|Login Bug Tracker]]
3. View issues as mentioned in the [https://nfvprivatewiki.etsi.org/index.php?title=Issue_Tracker_Process#:~:text=2.%20To%20view%20the%20list%20of%20all%20issues%2C%20click%20%22Issues%22%20under%20%22Pinned%22%20drop%20down%20button. Step 2] of the previous section.


== Submitting an Issue to the Issue Tracker ==
== Submitting an Issue to the Issue Tracker ==
Connect to the [http://forge.etsi.org/mantis/main_page.php ETSI bug tracker] and login.


Before submitting a new issue, please check that  
=== For Non-EOL Users ===
Non-EOL users cannot report issues directly via the '''ETSI NFV Issue Tracker'''. However, it is recommended that they submit their issues by sending an email to "'''NFVsupport@etsi.org"'''.


a) the issue still exists in the latest version of the respective GS document, and  
=== For EOL Users ===
Go to the [https://forge.etsi.org/rep/nfv/issues/-/issues ETSI NFV Issue Tracker] and login.


b) the issue has not yet been reported by someone else. If the latter is the case, please add a comment to the existing issue rather than reporting a new one.
Before creating a new issue, please check that:


To submit a new issue:
a) The issue still exists in the latest version of the respective GS document, and
# On the main screen choose project "NFV Specifications" and the sub-project for the corresponding GS document and then click "Report Issue".<br />[[File:Create_Report.png|600px]]<br /><br />
 
# In the form, choose the most appropriate category for the new issue (see table below):<br />[[File:Create_Report_Form.png|600px]]<br /><br />
b) The issue has not yet been reported by someone else. If the latter is the case, please add a comment to the existing issue rather than reporting a new one.
# Select the latest version of the GS document that contains the issue.
 
# Provide a descriptive one-line summary of the issue.
To create a new issue:
# Provide a detailed description of the issue: What specific issue did you encounter and where? What would you have expected to find instead?
# Go to [https://forge.etsi.org/rep/nfv/issues ETSI NFV Issue Tracker], click "'''Issues'''" under "'''Pinned'''" drop down button, and click "'''New issue'''".[[File:New issue.png|center|806x806px]]
# Optionally, provide additional information. This is the field to put references to external documents, if any.
# The '''Type''' is default set to "'''Issue'''" don't change it.
# Optionally, set the "View Status":
# '''Issue Title:''' In the issue Title input field, provide a clear and concise one-line summary of the issue.
#* If this is an ETSI NFV internal issue (e.g. gap tracking by the rapporteur) ''and'' this issue is still confidential because it refers to a non-public document, set to "private".
#* '''Following the format: [Version] <NFV-Specification> <Issue_title>'''
#* Else, keep as "public".<br />Note: We should keep our own issues public whenever possible, as this helps reducing duplicate reports.
#* '''For example:''' [v5.1.1] NFV-SOL003 Missing attribute in Query Compute Resources
# Click "Submit Report".
#'''Issue description:''' In the description input box, clearly explain the issue. Describe what the issue is, what the expected outcome should be, and include any additional details or links to relevant documents if available.
#'''Setting additional fields:'''
#*'''Assignee:'''  If you are going to resolve the issue yourself, choose "'''assign yourself'''" in the "'''Assignee'''" field. Otherwise, its Chair, Co-chair, or rapporteur, responsibility to assign the issue to the relevant individual.
#*'''Labels:''' Use labels to help organize and filter issues. When creating an issue, make sure to:
#**Add the appropriate ISG NFV Working Group (WG) label (e.g., "'''NFV-SOL'''" for a SOL specification issue).
#**Choose a label that describes the issue category: '''Bug''', '''Clarification''', or '''Feature Gap'''.
#*'''Dates and Milestone:''' If you are unsure with the dates and milestone, leave these fields as they are. These fields are supposed to be managed by Chairs, Vice-Chairs, or Rapporteurs, if needed.
#Once all necessary details are added, click "'''Create issue'''" to submit.
[[File:How to add new issue.png|center|796x796px]]
'''In case of confidential issues:'''
 
* If this is an ETSI NFV internal issue (e.g. gap tracking by the rapporteur) and this issue is still confidential because it refers to a non-public document, send it via email to "'''NFVsupport@etsi.org'''".
* Note: We should keep our own issues public whenever possible, as this helps reducing duplicate reports.


Issue categories:
Issue categories:
Line 53: Line 85:
| The specs are missing a feature (e.g. an operation, parameter) without which the described features cannot be implemented.
| The specs are missing a feature (e.g. an operation, parameter) without which the described features cannot be implemented.
|}
|}
== Monitoring Relevant Issue(s) ==
By default, the issue reporter (or creator) receives email notifications when someone comments on the issue, updates its status (e.g., closed or reopened), or performs other related actions. However, if you want to manage notifications for the issue(s) you are involved in:
1. Log in to the [https://forge.etsi.org/rep/nfv/issues ETSI NFV Issue Tracker].
2. In the Issue repository, click the '''bell icon''' in the issue repository and select "'''Participate'''" to receive updates on issues you are part of.
3. Select "'''On mention'''" option, to get notified only when you are specifically mentioned in a comment.
4. To stop receiving email notifications, select the "'''Disabled'''" option.
[[File:Relevant notification settings.png|762x762px]]
== Monitor All Issues ==
Users can also subscribe to receive email notifications for all activities within the repository.
1. Log in to the [https://forge.etsi.org/rep/nfv/issues ETSI NFV Issue Tracker].
2. In the Issue repository, click the '''bell icon''' in the issue repository and select "'''Watch'''" to get notified for all activity in the Issue repository.
3. To stop receiving email notifications, select the "'''Disabled'''" option.
[[File:All notification settings.png|762x762px]]

Latest revision as of 13:53, 25 July 2025

Login to the Issue Tracker

Login with EOL: NFV members and participants can login to the ETSI NFV Issue Tracker with their ETSI Online (EOL) account (used to log into the ETSI Portal).

Go to the ETSI NFV Issue Tracker and login.

User with EOL account can view and create issues, but users without EOL account can only view issues.

Issue tracker allows normal users to submit new issues and view public issues, but does not allow to process issues.

Chairs, Vice-Chairs, and Rapporteurs have a "Developer" or "Maintainer" role, which additionally allows viewing private issues and processing issues.

Login bug tracker.png

View Issues

1. Go to the ETSI NFV Issue Tracker and login.

2. To view the list of all issues, click "Issues" under "Pinned" drop down button.

3. To view issues by assignee, author, or label, click the search bar and choose the relevant option.

4. To find issues related to a specific specification, version, or other details, use the search bar to enter your keywords.

Review issues.png


5. To view the details of a specific issue, click title of the issue.

To open existing issue.png

Else how to navigate to the Issues Repository

1. Go to the ETSI Forge NFV Group.

2. Click on the "Issues" repository.

Navigate to issues repo.png

3. View issues as mentioned in the Step 2 of the previous section.

Submitting an Issue to the Issue Tracker

For Non-EOL Users

Non-EOL users cannot report issues directly via the ETSI NFV Issue Tracker. However, it is recommended that they submit their issues by sending an email to "NFVsupport@etsi.org".

For EOL Users

Go to the ETSI NFV Issue Tracker and login.

Before creating a new issue, please check that:

a) The issue still exists in the latest version of the respective GS document, and

b) The issue has not yet been reported by someone else. If the latter is the case, please add a comment to the existing issue rather than reporting a new one.

To create a new issue:

  1. Go to ETSI NFV Issue Tracker, click "Issues" under "Pinned" drop down button, and click "New issue".
    New issue.png
  2. The Type is default set to "Issue" don't change it.
  3. Issue Title: In the issue Title input field, provide a clear and concise one-line summary of the issue.
    • Following the format: [Version] <NFV-Specification> <Issue_title>
    • For example: [v5.1.1] NFV-SOL003 Missing attribute in Query Compute Resources
  4. Issue description: In the description input box, clearly explain the issue. Describe what the issue is, what the expected outcome should be, and include any additional details or links to relevant documents if available.
  5. Setting additional fields:
    • Assignee: If you are going to resolve the issue yourself, choose "assign yourself" in the "Assignee" field. Otherwise, its Chair, Co-chair, or rapporteur, responsibility to assign the issue to the relevant individual.
    • Labels: Use labels to help organize and filter issues. When creating an issue, make sure to:
      • Add the appropriate ISG NFV Working Group (WG) label (e.g., "NFV-SOL" for a SOL specification issue).
      • Choose a label that describes the issue category: Bug, Clarification, or Feature Gap.
    • Dates and Milestone: If you are unsure with the dates and milestone, leave these fields as they are. These fields are supposed to be managed by Chairs, Vice-Chairs, or Rapporteurs, if needed.
  6. Once all necessary details are added, click "Create issue" to submit.
How to add new issue.png

In case of confidential issues:

  • If this is an ETSI NFV internal issue (e.g. gap tracking by the rapporteur) and this issue is still confidential because it refers to a non-public document, send it via email to "NFVsupport@etsi.org".
  • Note: We should keep our own issues public whenever possible, as this helps reducing duplicate reports.

Issue categories:

Category Semantic
Bug Some aspect of the spec cannot be implemented as described.
Clarification Some aspect of the spec is ambiguous or unclear.
Feature Gap The specs are missing a feature (e.g. an operation, parameter) without which the described features cannot be implemented.

Monitoring Relevant Issue(s)

By default, the issue reporter (or creator) receives email notifications when someone comments on the issue, updates its status (e.g., closed or reopened), or performs other related actions. However, if you want to manage notifications for the issue(s) you are involved in:

1. Log in to the ETSI NFV Issue Tracker.

2. In the Issue repository, click the bell icon in the issue repository and select "Participate" to receive updates on issues you are part of.

3. Select "On mention" option, to get notified only when you are specifically mentioned in a comment.

4. To stop receiving email notifications, select the "Disabled" option.

Relevant notification settings.png

Monitor All Issues

Users can also subscribe to receive email notifications for all activities within the repository.

1. Log in to the ETSI NFV Issue Tracker.

2. In the Issue repository, click the bell icon in the issue repository and select "Watch" to get notified for all activity in the Issue repository.

3. To stop receiving email notifications, select the "Disabled" option.

All notification settings.png