LibCrowds / libcrowds

The frontend for the LibCrowds crowdsourcing platform
MIT License
33 stars 6 forks source link

Update 'how to add a new volume' documentation #850

Open mialondon opened 5 years ago

mialondon commented 5 years ago

As per https://github.com/LibCrowds/libcrowds/issues/843#issuecomment-524083526

First: find the current documentation

mialondon commented 5 years ago

Before you start: Check that the volume isn't already on the site. If it is, you might want to add new tasks to it (but it might also need fixing as on https://github.com/LibCrowds/libcrowds/issues/849)

If it isn't, find the volume you want in the BL catalogue, and copy the manifest address from the 'iiif' logo on the 'Share' pop-up. You can right-click to copy the manifest address, or click the logo to open a new window. Initially, the manifest address may be in there twice, like this: https://api.bl.uk/metadata/iiif/ark:/81055/vdc_100022589012.0x000002/manifest.json?manifest=https://api.bl.uk/metadata/iiif/ark:/81055/vdc_100022589012.0x000002/manifest.json

It seems best to copy just the last part of it (starting with the second 'https'). Paste it into a browser window to check that it loads a JSON page, then you can use the link in step 3 below.

Notes from Geoffroy Noël copied over from #843

Here is how I managed to create a volume, a project and import the tasks:

  1. create a new volume in the admin by first selecting playbill collection then going to Volumes page and clicking the New button;
  2. fill in the form (Name, short name and importer = iiif) and submit
  3. go to the "Import Source" tab and insert the link to the manifest (please try that link in another browser tab first to make sure it actually returns a json file)
  4. click "update import source" button and wait for the success message
  5. Just to make sure, you can reload the page and go to the "Import Source" tab to verify that the value isn't empty (many problematic volumes do have an empty value)

6 . Create a new project in the usual way (/admin/project/new/playbills)

  1. On the creation form select in the template (e.g. Dates), the newly created volume, ... and press Create
  2. It should show a success message
  3. After the screen reloads, tag the Task, Entity and Location then Click Update

After step 8, Libcrowds will create a background job of Medium priority to import the tasks from the manifest. This job is queued and can therefore take several minutes before it comes at the top. You should be able to see that job in the Admin:

You can also see those import tasks on your admin Dashboard, under the New Task section.

mialondon commented 4 years ago

Some additional documentation and previous discussion that will be useful in understanding the In the Spotlight volume loading issue:

https://github.com/LibCrowds/libcrowds/issues/862 - the current issue. As mentioned in the discussion, we've noted actions taken at specific times, which can be linked to the extensive collection of trace errors

https://github.com/LibCrowds/libcrowds/issues/843 - an original report of a loading bug, with some work by an external agency

https://github.com/LibCrowds/libcrowds/issues/850 - steps to add a new volume to the backend, which should provide opportunities to see the bug in action

https://docs.libcrowds.com/ - documentation for the LibCrowds platform. If there are areas where this is incomplete, we can look to update it as relevant information is uncovered.

https://docs.pybossa.com/ - documentation for the underlying Pybossa platform

https://vue-a11y.com/ - accessibility fixes from the vue.js community that might help address other issues