This directory contains the documentation specifically targeted at developers of the HPCC system.
::: tip These documents are generated from Markdown by VitePress. See VitePress Markdown for more details. :::
-
Development guide: Building the system and development guide.
-
C++ style guide: Style guide for c++ code.
-
Documentation style guide: Style for writing.
-
ECL style guide: Style guide for ECL code.
-
Code Submission Guidelines: Guidelines for submitting PRs
-
Code Review Guidelines: Guidelines for reviewing submissions PRs
-
Building with Github Actions: How to build source using Github Actions
-
Running HPCC Platform on macOS: Manual configuration for a local macOS runtime
-
Writing Developer Documentation: How to ensure your documentation conforms to our style and voice
-
Log Cost Mitigation Outline: Outline of log cost mitigation heuristics for developers
-
GitHub Wiki: GitHub wiki for HPCC-Platform
- Workunit Workflow: An explanation of workunits, and a walk-through of the steps in executing a query.
- DFS FileAccess Audit Centralization: Contract and migration guide for DFS-owned FileAccess auditing.
- Code Generator: Details of the internals of eclcc.
- Roxie: History and design details for roxie.
- Memory Manager: Details of the memory manager (roxiemem) used by the query engines.
- Metrics: Metrics Framework Design.
- PDFs: The formal HPCC Platform documentation is on the HPCC Systems website.