Skip to content

User Story: OpenMCP Documentation #49

@reshnm

Description

@reshnm

Understand the User Story

  • As an OpenMCP developer I want to have documentation that describes the basic building blocks and architecture of an OpenMCP landscape
  • As a Provider developer I want to have documentation how to implement a new Cluster Provider, MCP Service Provider, Platform Service
  • As an OpenMCP landscape operator I want to have documentation how to set-up and maintain an OpenMCP landsape
  • As an OpenMCP user I want to have documentation on how to order MCPs/Services (onboarding)
  • As an OpenMCP user I want to have documentation on how to use Services (BTP, Flux etc.) on a MCP (Feature docs)
  • As an OpenMCP contributor I want to have documentation how contribution to the project works
  • As an OpenMCP document content creator I want to have appropriate technology to write and publish documentation

Tasks

Proposed documentation topics/structure (alphabetical order)

.
├── About
│   ├── Adopters
│   ├── Architecture
│   ├── Concepts
│   ├── Ecosystem
│   ├── FAQ
│   ├── Glossary
│   └── Purpose
├── Developers
│   ├── API Contracts (Lightweight RFC-like)
│   ├── API Reference (CRD Browser)
│   ├── Code of Conduct
│   ├── Dev Workflow
│   ├── Developing a Cluster Provider
│   ├── Developing a Platform Service
│   ├── Developing a Service Provider
│   ├── Getting Started
│   └── Testing
├── Operators
│   ├── Common Tasks
│   ├── Getting Started
│   ├── Installation (Gardener)
│   ├── Installation (Local)
│   ├── Maintainance
│   └── System requirements
└── Users
    ├── Accessing your MCP
    ├── Additional Resources (K8s Learning)
    ├── Components
    ├── Getting Started
    ├── Programmatic access
    └── Use cases

What is required to accept the User Story as finished.

N/A

Dependencies

No response

Any further valuable resources.

No response

Sub-issues

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions