PAW Technical Manual

Welcome to the PAW Technical Manual! This section of the manual is intended for those seeking to maintain or extend the PAW. The technical manual is broken up into three parts: Descriptive, explaining how the PAW exists and the architectural descicionts that went into it; Maintainance, listing key areas of concern w.r.t. maintainability, along with guides listing the steps that are expected to be required to solve the expected issues; and Extension, highlighting pieces of the paw purpose-built to be extensible, while explaining the framework in place to extend these areas.

• Descriptive: An Architectural View of The Paw
  • Overview:
    • Component-based:
    • ElasticWrap internals:
  • Detailed sections on specific components:
    • Grimoirelab
      • What is a Grimoirelab?
      • Overview
      • Why Grimoirelab?
      • Changes to Grimoirelab
    • Multi-Mordred
      • What is a multi-mordred?
      • What is a Mordred?
      • Overview:
      • Custom Scripts
      • Why is a multi-mordred?
    • ElasticWrap
      • Why is elasticWrap?
      • Overview
      • Elasticwraps, how do they work?
        • Namespaces
      • Search Clients
      • DataSources
  • On Kibiter
• Maintainance: Maintaining The Paw
  • Extensions to the Build Process
    • Production Environment
      • Production ElasticSearch
      • Production SortingHat
    • Changes in Dependencies
    • Updating MultiMordred
  • Manually re-making the Custom Script Extension
    • Registering new config variables
    • The CustomScript Task itself
    • Executing the task
      • sirmordred.py
      • micromordred
  • Long-term maintainance with regards to PAW-Architecture
    • Cutting out the problem-children of Grimoirelab
    • The role of ElasticSearch
    • Kibiter support
• Extension: Extending The PAW
  • Adding retrievers for custom datasources
    • Defining the retriever
    • Adding the retriever
    • Re-building with the retriever
    • Using the retriever
  • Adding searchers for custom data ElasticSearch patterns
    • Defining the Data
      • Common Data Structures
        • ElasticSearch
        • Perceval
      • Actually Defining The Data
    • Creating the Search Client
  • Adding ElasticWrap support for custom data formats
    • How to implement DataSource