Difference between revisions of "Development/Summer of Code/2020/BookBrainz"

From MusicBrainz Wiki
Jump to navigationJump to search
Line 90: Line 90:
=== Documentation and style guides ===
=== Documentation and style guides ===
Proposed Mentors: ''Monkey''<br>
Languages/skills: Node.js, SQL, writing documentation
[https://community.metabrainz.org/c/bookbrainz Forum for discussion]
The BookBrainz documentation (both technical/development and style/usage) is currently very poor, fragmented and hard to find.
The BookBrainz documentation (both technical/development and style/usage) is currently very poor, fragmented and hard to find.

Revision as of 12:53, 3 February 2020

This page will discuss the current list of suggested ideas for students to develop proposals for Google's Summer of Code for BookBrainz. If you're a student, feel free to base your proposal on one of these ideas, or pick and entirely new idea that you think might be useful to us.

Getting Started

(see also: Getting started with GSoC)

The first thing to do to get started with BookBrainz is to clone the bookbrainz-site GitHub repository, and follow the README.md file to get the site up and running on your computer.

Come and speak to us in the MetaBrainz IRC (freenode/#metabrainz) if you finish all of that, or get stuck at any point!


Design and implement a unified creation form

Proposed Mentors: Monkey
Languages/skills: User interfaces, User Experience, React, Node.js

Forum for discussion

If you are familiar with BookBrainz, you will know that each entity has a separate creation page. You can see these in the website's menu bar under "+ Add".

This leads to a complex workflow for simple use cases (such as 'adding a book') and repeating data (for example the title of a work repeated for an edition and an edition group, in a simple use case of a book), increasing chances of making errors. Such an evident workflow should be a lot more straightforward (especially for inexperienced users). The goal of this project is to design and implement a single form that will improve the editing experience.

Some form of separation (like tabs) will likely be necessary to separate the different entities forms as steps. For each step, entities can be either searched for and selected, or created. While it would be best to show only the strict necessary fields for each step at first to limit clutter, users should have the full range of options of the current forms accessible easily. The form will automatically create the relevant relationships and links between the entities.

Keep in mind that "adding a book" is a simple case, and that we should be able to optionally enter more complicated cases (for example an anthology of short stories will have multiple Works, and the title of the Edition may be different from any of the Works it contains). Or an anthology of various Authors might be attributed on the cover to a single Author.

The first phase should be to make a mockup with a prototyping/wireframing tool such as Sketch, Figma or Pencil Project. You will be expected to develop the components using MetaBrainz' new React-storybook design system. We will work together iteratively during both the UX and implementation sections of the project.

Use Solr search engine

Proposed Mentors: Monkey
Languages/skills: Node.js, Solr, (PostgreSQL)

Forum for discussion

BookBrainz currently uses ElasticSearch for its search engine, and we are aiming to replace it in favor of Solr.

This will simplify hosting BookBrainz on the same infrastructure as the other MetaBrainz projects and harmonize the technologies we use. ElasticSearch is also quite resource intensive and creating some issues for developers on slower computers.

A good understanding of NodeJS and ExpressJS is required to find and replace the relevant components in the web server.

You will set up Solr for use with Bookbrainz' schema, drawing inspiration from existing MusicBrainz code.

On the Node side, you will aim to reproduce the current search functionalities (have a look here ), including updating the Solr index on creation/modification of entities (as described in the docs . Currently this is done like this for ES). In addition, we would like to add pagination to the search page, which should be fairly simple to achieve with Solr.

Communicating with Solr can be done simply via HTTP requests. If needed, it could otherwise be done using a JS library if deemed suitable.

You will also be involved in the preparation of the production deployment, adapting existing Docker configurations from MusicBrainz.

User collections

Proposed Mentors: Monkey
Languages/skills: React, Node.js, User Experience, SQL

Forum for discussion

With all this data available, it would be great if BookBrainz users could use the website to save the books they have read, mark the ones they would like to read, mark gifts ideas, etc.

Using test-driven development, you will develop a user collection feature that will allow users to create, organize and retrieve collections.

A collection can only contain one type of entity (Author, Work, Edition Group, etc.). A user can create an arbitrary number of collections with an arbitrary number of items in it. A collection can be set to private or public, and can have an optional description.

On the front-end, there should be a new page (`/user/{USERNAME}/collections`) to view another user's public collections, or view and manage (edit name, set private/public and description, delete) all one's own collections.

Each collection has its own page for display purposes, where a user can remove and add items, and change the collection's settings.

There should also be easily accessible ways of adding entities to your collections, at the very least in the entity display pages, but also possibly in the search page, homepage, etc. You will suggest appropriate places for such buttons.

Clicking on an "add to collection" button will require to show a component to choose which collection to add to (filtered by type corresponding to the entity to add), or to create a new collection on the fly.

Using a prototyping/wireframing tool will help for the design and user experience iterations. You will learn to use MetaBrainz' new React-based design system

This feature could also help us build a recommendation engine in the future, along with data from CritiqueBrainz.

Documentation and style guides

Proposed Mentors: Monkey
Languages/skills: Node.js, SQL, writing documentation

Forum for discussion

The BookBrainz documentation (both technical/development and style/usage) is currently very poor, fragmented and hard to find. There is a stub of user guides here. And auto-generated developer documentation was previously running here but the hosting service deoclet.io is now defunct.

The goal of this project is to revive, correct and complete both of these documentations.

For the user guides, you will take the MusicBrainz guides as an example. You will write a beginner user's guide and flesh out the existing FAQ You will also take the MusicBrainz style guides and try to apply everything you find there to the world of books. This also includes descriptions of each field for each entity, relationships between them, identifiers, and every part of the interface that requires an explanation.

For the developper documentation, you will need to find a replacement for Doclets and set up automated deployment of the docs (from JSDOC comments in the main codebase). You will also identify (with the mentor) the areas of the code and of the project that are not well documented, identify the most critical ones (for example those blocking new contributors), and improve their documentation. Current code coverage is around 42%, which can be significantly improved.