Developer documentation

Contains documentation for developers and contributors.

Contents

• Rocky
  • Stack
  • Running Rocky
    • Containerized
    • Locally
  • Installation
    • Running
    • First run
    • Testing
    • Database
  • Fonts license
    • Fredoka
    • Open Sans
    • Tabler icons
• Rocky Design
  • Running a boefje
• Rocky View Structure
  • Overview of child Views of the OrganizationViews
  • Exhaustive overview of OctopoesViews
  • KATalogus Views
• Scheduler
  • Purpose
  • Architecture
    • Stack, packages and libraries
    • External services
    • Project structure
  • Running / Developing
    • Prerequisites
    • Running
  • Testing
• Boefjes
  • Prerequisites
  • KATalogus
    • Organisations
    • Repositories
    • Plugins
    • Settings
  • Environment variables
  • Design
    • Boefje and Normalizer Workers
      • Design
      • Worker failure mode
    • Running as a Docker container
    • Running the worker directly
    • Example job
    • Manually running a boefje or normalizer
    • Boefje and normalizer structure
    • Running the test suite
• Bytes
  • Installation
    • With Docker
    • Without Docker
    • Hashing and Encryption
    • Observability
  • Design
    • Design: C2 Container level
    • Design: C3 Component level
  • Development
    • Code style and tests
    • Migrations
    • Export SQL migrations
  • Production
    • Performance tuning
• Octopoes
  • Instructions
    • Run Octopoes API
    • Run the event processor
  • Healthcheck
  • OOI
  • Origin
  • Origin through declaration
  • Origin through observation
  • Origin through inference
  • Graph mutations
  • Code Architecture
    • Sequence: save_origin
    • Sequence: process update ooi
  • Crux / XTDB
  • OOI
  • Relationships
  • A few example records
  • OOI Reference
  • Octopoes API
    • OctopoesAPIConnector
      • Querying objects
  • Abstract classes / subclassing
  • Querying
  • Run bit manually
  • Tests
• Octopoes Research
  • Introduction
  • Part I - Requirements, context and inherent complexities
    • Context of Octopoes in KAT
      • Event loop
      • KAT dataflow
    • Objectives
      • KAT
      • Octopoes
      • Desired/future
    • Complexities of Octopoes
      • Open-world assumption
      • Contradicting information
      • Logic
      • Reasoning
      • Consistency
      • Logical programming
      • Computing inferences and materialization
      • What knowledge can we actually infer from our objects?
      • Knowing things
      • Not knowing things
      • Knowing that you don’t know things
      • Other assorted notes and thoughts
  • Part II - Working towards a solution
    • Stages of data processing
      • Data model / domain of discourse
      • Upfront DDL?
      • Entity ID
    • ClaimSpace
    • FactSpace
    • Inference
    • Handling updates / incoming data
      • Batch processing
      • Incremental processing / streaming
• Keiko
  • Installation requirements
  • File system permissions
  • Running the API
  • Logging
  • Building a new template
  • Generating a report
  • Testing a report with command line