Skip to content

IronCore Project

Style Guide

IronCore Project

Home
Infrastructure as a Service
Infrastructure as a Service
- Getting Started
- Architecture
  Architecture
  - Overview
  - Scheduling and Orchestration
  - Operating System Images
  - Providers
    Providers
    
    Overview
    
    RuntimeInterface
    
    Compute Provider
    
    Storage Provider
  - Networking
- User Guide
  User Guide
  - Tutorials
- Kubernetes Integration
  Kubernetes Integration
- Operations Guide
  Operations Guide
  - Overview
  - Landscape Setup
- Components
  Components
  - Ironcore
    
    Ironcore
    
    Architecture
    Architecture
    
    Overview
    
    Runtime Interface
    
    Concepts
    Concepts
    
    Machine Exec
    
    Usage
    Usage
    
    Installation
    
    Compute
    Compute
    
    MachinePool
    
    MachineClass
    
    Machine
    
    Storage
    Storage
    
    VolumePool
    
    VolumeClass
    
    Volume
    
    BucketPool
    
    BucketClass
    
    Bucket
    
    Networking
    Networking
    
    Network
    
    NetworkInterface
    
    NATGateway
    
    LoadBalancer
    
    VirtualIP
    
    NetworkPolicy
    
    IPAM
    IPAM
    
    Prefix
    
    Core
    Core
    
    ResourceQuota
    
    Developer Guide
    Developer Guide
    
    Local Setup
    
    Documentation
    
    Testing
    
    Contribution Guide
    
    Proposals
    
    API Reference
    API Reference
    
    Overview
    
    IPAM
    
    Core
    
    Compute
    
    Networking
    
    Storage
    
    Common
  - Ironcore Net
    
    Ironcore Net
    
    Concepts
    Concepts
    
    IP lifecycle
    
    Ironcore integration
    
    Network lifecycle
    
    Objects
    
    Developer Guide
    Developer Guide
    
    Local Setup
    
    API Reference
    API Reference
    
    Core
  - Libvirt Provider
    
    Libvirt Provider
    
    Architecture
    
    Concepts
    Concepts
    
    Console
    
    Events
    
    Plugins
    Plugins
    
    NIC
    
    Volume
    
    Usage
    
    Development Guide
    Development Guide
    
    Local Setup
    
    Documentation
  - Ceph Provider
    
    Ceph Provider
    
    Architecture
    
    Usage
    
    Developer Guide
    Developer Guide
    
    Local Setup
    
    Main Documentation ⧉
    
    Landing Page ⧉
Bare Metal Management
Bare Metal Management
- Getting Started
- Architecture
  Architecture
- User Guide
  User Guide
  - Tutorials
- Kubernetes Integration
  Kubernetes Integration
- Operations Guide
  Operations Guide
  - Overview
  - Landscape Setup
- Components
  Components
  - Metal Operator
    
    Metal Operator
    
    Architecture
    
    Concepts
    Concepts
    
    Endpoints
    
    BMCs
    
    BMCSecrets
    
    Servers
    
    ServerBootConfigurations
    
    ServerClaims
    
    ServerMaintenance
    
    Usage
    Usage
    
    metalctl
    
    Development Guide
    Development Guide
    
    Local Setup
    
    Documentation
    
    API Reference
  - Boot Operator
    
    Boot Operator
    
    Architecture
    
    Development Guide
    Development Guide
    
    Documentation
    
    Create Sample UKI Image
    
    API Reference
Developer Guide
Contribute
Contribute
- Style Guide
- Contributing

Documentation Style Guide¶

This style guide outlines the standards for writing and formatting documents for the IronCore project.