Skip to content

Before opening issues

Neelakandan Manihatty Bojan edited this page Dec 15, 2015 · 1 revision

Steps to be followed before opening an issue in the repo

Users are requested to follow these steps before opening a ticket or asking a question on one of the mailing lists:

##1. Go through the Wiki:

Read the documentation for NetFPGA SUME from the [wiki pages] (https://github.com/NetFPGA/NetFPGA-SUME-public/wiki) , especially the Getting Started Guide.

2. Check the FAQ section:

Take some time to read the [Frequently Asked Questions] (https://github.com/NetFPGA/NetFPGA-SUME-public/wiki/NetFPGA-SUME-FAQ) and make sure that your question is not already answered.

3. Your trials and logs

If you have tried solving the problem on your own, please post the results of your trials as logs etc. Your trials and logs will generally attract more positive attention from people reading it. Trying to solve the problem yourself will also enhance your understanding of the NetFPGA platform, and will eventually let you use your knowledge to help others by answering questions posted to the mailing lists.

User error logs are useful starting point. It your question is errors that occur during the setting up a NetFPGA sume machine, then more detailed logs about your host machine, operating system, version of the tool chain you are running will also be useful. Take a look at question 1 here. Please provide a link to large logs rather than attaching them to the email.

All the above will help us provide more constructive feedback.

How to submit a question

Please consider the following before submitting a question:

  • NetFPGA is a community driven effort. Users in the community answer the question out of their own free will. You can influence this free will positively by submitting a well-formulated question supplying as much relevant information as possible.

  • Specify as much information as possible

    • What is your HW (System configuration) and SW (OS version) your are running
    • Which release tag you are using
    • Which Xilinx tool chain you are running
    • Provide more details about the error messages that you receive.

Where should you submit the question?

Once you have your questions written based on the above recommendations, consider writing to the correct mailing list based on the type of your question.

Below you can find the mailing lists and their purpose.

List Purpose
cl-netfpga-sume-beta This is the mailing list for users of NetFPGA SUME. Anyone using NetFPGA-SUME must subscribe to this list through the registration form. This is a technical mailing list for which strictly technical content is expected.
cl-netfpga-nf10g-beta This is the mailing list for users of NetFPGA-10G community.
cl-netfpga-cml-beta This is the mailing list for users of NetFPGA-1G CML community.
cl-netfpga-announce This is the NetFPGA announce mailing list. Subscribe to this mailing list for general updates on releases, tutorials, workshops etc. Technical questions should not go on this list.

4. Opening an issue ticket:

If you still have a NetFPGA SUME problem/issue, that is still unresolved, then we suggest that you open a ticket under NetFPGA-SUME-live. Please do not include issues that relate to other NetFPGA platforms or non-technical issues.

Clone this wiki locally