Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.43 KB

File metadata and controls

56 lines (42 loc) · 2.43 KB

Development Documentation

Welcome to the development section of the Flamingo Registry. This section covers everything you need to contribute to the registry, understand its architecture, and follow best practices for security, testing, and collaboration.

Overview

The Flamingo Registry is an open-source catalog repository within the OpenFrame platform ecosystem. Contributing to it means adding, updating, or validating structured data entries (services, integrations, components) that power the MSP automation platform.

Documentation Index

Guide Description
Environment Setup IDE setup, recommended tools, and editor configuration
Local Development Cloning, running locally, and validating changes
Architecture Overview How the registry is structured and how it fits in the platform
Security Guidelines Secrets management, access control, and secure contribution patterns
Testing Overview How to validate registry entries and run checks
Contributing Guidelines Code style, branching, commit messages, and PR process

Quick Navigation

graph LR
    Dev["Development\nDocs"]
    Env["Environment\nSetup"]
    Local["Local\nDevelopment"]
    Arch["Architecture\nOverview"]
    Sec["Security\nGuidelines"]
    Test["Testing\nOverview"]
    Contrib["Contributing\nGuidelines"]

    Dev --> Env
    Dev --> Local
    Dev --> Arch
    Dev --> Sec
    Dev --> Test
    Dev --> Contrib
Loading

Who Should Read This Section?

Audience Relevant Guides
First-time contributors Environment Setup → Local Development → Contributing Guidelines
Platform operators Architecture Overview → Security Guidelines
CI/CD maintainers Testing Overview → Local Development
Security reviewers Security Guidelines → Contributing Guidelines

Getting Help

All support and discussion happens on the OpenMSP Slack community:

The repository is hosted at: https://github.com/flamingo-stack/registry