Improve Arquivo404 documentation

arquivo / pwa-technologies

Arquivo.pt main goal is the preservation and access of web contents that are no longer available online. During the developing of the PWA IR (information retrieval) system we faced limitations in searching speed, quality of results, scalability and usability. To cope with this, we modified the archive-access project (http://archive-access.sourceforge.net/) to support our web archive IR requirements. Nutchwax, Nutch and Wayback’s code were adapted to meet the requirements. Several optimizations were added, such as simplifications in the way document versions are searched and several bottlenecks were resolved. The PWA search engine is a public service at http://archive.pt and a research platform for web archiving. As it predecessor Nutch, it runs over Hadoop clusters for distributed computing following the map-reduce paradigm. Its major features include fast full-text search, URL search, phrase search, faceted search (date, format, site), and sorting by relevance and date. The PWA search engine is highly scalable and its architecture is flexible enough to enable the deployment of different configurations to respond to the different needs. Currently, it serves an archive collection searchable by full-text with 180 million documents ranging between 1996 and 2010.

http://www.arquivo.pt

GNU General Public License v3.0

38 stars 7 forks source link

Improve Arquivo404 documentation #1244

Closed VascoRatoFCCN closed 2 years ago

VascoRatoFCCN commented 2 years ago

Arquivo404's documentation is confusing:

Lacks examples for the methods
Method descriptions hardly distinguish between different methods ( "message" vs "addMessage" vs "messages" )
Too many methods that overlap in functionality. We should support the minimum amount of methods to allow the user to change the message, language and add archive.

VascoRatoFCCN commented 2 years ago

Unrelated, but we should also change arquivo404's default language to 'pt' rather than navigator.language.

VascoRatoFCCN commented 2 years ago

The team decided to deprecate multilanguage support and instead simply give the tools to edit the message and date format.

https://github.com/arquivo/arquivo404/commit/82c97d9c3d0946f033944ce2d9cb2730ab89f520 applies this change.

VascoRatoFCCN commented 2 years ago

Documentation has been updated, closing this issue.