Skip to content

Latest commit

 

History

History
127 lines (95 loc) · 6.27 KB

File metadata and controls

127 lines (95 loc) · 6.27 KB

Documentation Bookmarks

Central index of key documentation in the ODH Dashboard monorepo.


Getting Started

Doc Description
CONTRIBUTING.md Contribution guidelines
README.md Project overview
Dev Setup Development environment setup

Architecture & Design

Doc Description
Architecture Overall system architecture
Architecture Decisions Key architecture decisions (monorepo, Module Federation, Turbo)
Module Federation Module Federation implementation
Extensibility Plugin/extension system
Quality Gates Modular architecture quality standards

Development Workflows

Doc Description
PR Review Guidelines PR review process
Pre-Commit Hooks Pre-commit hook details
Best Practices Coding best practices
Code Examples Code examples and patterns

Testing

Doc Description
Testing Guide Comprehensive testing guide
Cypress Tutorial Cypress testing tutorial

Process & Collaboration

Doc Description
OWNERS Management OWNERS file management
Definition of Ready DoR for features
Definition of Done DoD for tasks
SMEs Subject matter experts

Deployment & Operations

Doc Description
Release Steps Release process
Environment Variables Environment configuration
Observability Monitoring and observability
Onboarding Modules Onboarding new modules

Frontend Areas

Active frontend areas in frontend/src/pages/. Model Registry, Model Serving, and Model Catalog are deprecated in the main frontend — see Package docs below.

Doc Description
Pipelines Pipeline runs, DAG viewing, artifact tracking, Kubeflow Pipelines integration
Workbenches Notebook creation, JupyterLab, gateway-based routing (v3.0+), notebookController
Projects Data Science Projects hub — primary entry point for workbenches, pipelines, serving, storage, connections
Distributed Workloads Kueue workload management, distributed training job monitoring
Gen AI / LLM Host-side LLM feature flags and type definitions; actual UI lives in federated packages (gen-ai, eval-hub)
Home / Applications Application tile dashboard, enabled apps, learning center
Admin Settings Cluster settings, group management, storage classes, hardware profiles, BYON images, connection types

Backend

Doc Description
Backend Overview Authentication strategies, proxy/pass-through architecture, k8s integration, service account calls, environment config

Packages

Full Docs

Doc Description
Model Registry Model Registry UI — canonical doc (replaces deprecated frontend area); upstream Go BFF, model versioning
Model Serving Model Serving UI — canonical doc (replaces deprecated frontend area); KServe/ModelMesh runtimes
KServe KServe-specific serving package; InferenceService CRDs, serving runtime management
AutoML AutoML pipeline optimization; Go BFF; Kubeflow Pipelines orchestration
AutoRAG Automated RAG configuration optimization; Go BFF; three deployment modes
Eval Hub Model evaluation hub; Go BFF; eval metrics; model-registry integration
Gen AI Gen AI / LLM chatbot package; Go BFF with MCP/LSD clients; model serving interactions
MaaS Model as a Service; Material UI (Kubeflow); Go BFF; LLM endpoint management
MLflow MLflow experiment tracking integration; experiment/run browsing UI
MLflow Embedded Embedded MLflow UI variant; Module Federation config
Model Training Training job management; pipeline integration; resource configuration
Notebooks Notebook management package; workbenches frontend area interactions
Observability Metrics, logging, tracing integration; Prometheus endpoint patterns
Feature Store Feature store management UI; dataset versioning
LLMD Serving LLM-dedicated serving; interactions with gen-ai frontend area

Stubs (tooling-only packages)

Doc Description
App Config Shared runtime and build-time configuration utilities
ESLint Config Shared ESLint rules and configurations
ESLint Plugin Custom ESLint plugin rules
Jest Config Shared Jest test runner configurations
Plugin Core Core plugin infrastructure and extension-point definitions
Plugin Template Starter template for new modular packages
TSConfig Shared TypeScript compiler configurations