MetaBrainz Foundation

Extend the FAQ section on AcousticBrainz website

Right now on AcousticBrainz we have a FAQ section which requires more questions to be added. There should be FAQs regarding the information about datasets and evaluation process.

The current FAQ page can be found in acousticbrainz-server/webserver/templates/index/faq.html.

The following information needs to be added.

Let's have examples. For datasets: Add the details about how the datasets are created, minimum number of recordings for each dataset and add the API information. The API information can link to the documentation. Add the information about different running states of datasets viz. Pending, Running, Done and Failed.

For the dataset evaluation process: Your task includes adding how the user should start the evaluation of any dataset, an explanation of what the evaluation process does, and the parameters to select before starting the evaluation, along with the details of each parameters.

You can add as many questions and corresponding answers which make the AcousticBrainz website as simple as possible for new users.

Task tags

  • faq
  • datasets
  • acousticbrainz
  • documentation

Students who completed this task

Coder44

Task type

  • chrome_reader_mode Documentation / Training
  • assessment Outreach / Research
close

2019