Welcome to the documentation hub for the Flamingo Registry, the open-source service catalog and discovery hub for the OpenFrame MSP platform ecosystem.
New to the Flamingo Registry? Start here. These guides take you from zero to making your first registry contribution.
| Guide | Description |
|---|---|
| Introduction | What the Flamingo Registry is, how it fits into OpenFrame, and who it's for |
| Prerequisites | Required tools, accounts, and environment checks before you begin |
| Quick Start | Clone the repo, explore the catalog, and add your first entry in minutes |
| First Steps | Understand the structure, configure your editor, and connect with the community |
Everything you need to contribute, validate, and maintain the registry catalog.
| Guide | Description |
|---|---|
| Development Overview | Index of all development guides and who should read each one |
| Architecture Overview | How the registry is structured, the catalog data model, and how it integrates with the OpenFrame platform |
| Guide | Description |
|---|---|
| Environment Setup | IDE recommendations, required tools (yamllint, jq), and editor configuration |
| Local Development | Cloning, working with catalog entries, validating changes, and branching workflow |
| Guide | Description |
|---|---|
| Contributing Guidelines | Naming conventions, branch strategy, commit message format, and the PR review process |
| Testing Overview | Multi-layer validation approach: YAML lint, schema validation, integrity checks, and CI pipeline |
| Security Guidelines | Secrets management, access control, URL safety, and the security PR checklist |
| Resource | Link |
|---|---|
| Project README | ../README.md |
| Contributing Guide | ../CONTRIBUTING.md |
| GitHub Repository | https://github.com/flamingo-stack/registry |
| Open a Pull Request | https://github.com/flamingo-stack/registry/pulls |
| Releases | https://github.com/flamingo-stack/registry/releases |
| OpenMSP Slack Community | https://www.openmsp.ai/ |
| Flamingo Platform | https://flamingo.run |
| OpenFrame Platform | https://openframe.ai |
💬 Need help? All support and discussion happens on the OpenMSP Slack community. We do not use GitHub Issues or GitHub Discussions.
Documentation generated by 🦩 Flamingo AI Technical Writer