Contributor Documentation¶
Welcome to the ODG contributor documentation. This section is for those who want to understand, extend, or contribute to Open Delivery Gear.
Note
This documentation is organised using the Diataxis framework:
Concepts: Understanding-oriented explanations
How-to Guides: Problem-oriented, goal-focused instructions
Tutorials: Learning-oriented lessons
References: Information-oriented technical descriptions
Guided Tour¶
🚀 Zero to Hero
New to ODG? Start here to understand the fundamentals and get up to speed.
Documentation¶
📚 Concepts
Understanding-oriented explanations of ODG architecture and principles
🛠️ How-to Guides
Problem-oriented, goal-focused instructions for specific tasks
🎓 Tutorials
Learning-oriented lessons to get hands-on experience with ODG
📖 References
Information-oriented technical descriptions and API documentation
- Getting Started
- Concepts
- How-to Guides
- Setting up a hybrid dev setup
- Deploying the Open Delivery Gear Locally
- Use the ODG Python Package to resolve an OCM component
- Get all vulnerabilities for a Component
- Send Diki findings to ODG-API
- Download SBOM Documents
- Diagnose Failed SBOM Generation
- Change the SLAs for Vulnerability Findings
- Run custom SQL commands in ODG
- Prepare Your Component for ODG
- Tutorials
- References