From ff2fcc66454471386a880da171554e69ec3ab3e3 Mon Sep 17 00:00:00 2001 From: Artem Kovalov Date: Mon, 9 Nov 2026 21:57:38 +0100 Subject: [PATCH 1/3] docs: add governance page with TSC, SIGs, and contribution pathways Signed-off-by: Artem Kovalov --- docs/.vitepress/config.mts | 24 ++++++++++++++++ docs/governance/index.md | 59 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100644 docs/governance/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index e180b54..fb6f244 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -69,6 +69,28 @@ function observabilitySidebar() { }; } +function governanceSidebar() { + const generated = generateSidebar([{ + documentRootPath: '/docs/', + scanStartPath: 'governance', + resolvePath: '/governance/', + capitalizeFirst: false, + useTitleFromFrontmatter: true, + useFolderLinkFromIndexFile: true, + useFolderTitleFromIndexFile: true, + sortMenusByFrontmatterOrder: true, + }]); + const items = generated['/governance/'].items.filter((i: any) => i.link !== 'index.md'); + return { + '/governance/': { + base: '/governance/', + items: [ + { text: 'Governance', items: [{ text: 'Overview', link: 'index.md' }, ...items] }, + ], + }, + }; +} + // https://vitepress.dev/reference/site-config export default withMermaid({ title: "CobaltCore", @@ -128,6 +150,7 @@ export default withMermaid({ }, { text: 'Blog', link: '/blog/' }, { text: 'Community', link: '/community/' }, + { text: 'Governance', link: '/governance/' }, ], editLink: { @@ -221,6 +244,7 @@ export default withMermaid({ ...storageSidebar(), ...observabilitySidebar(), ...overviewSidebar(), + ...governanceSidebar(), }, socialLinks: [ diff --git a/docs/governance/index.md b/docs/governance/index.md new file mode 100644 index 0000000..dde7013 --- /dev/null +++ b/docs/governance/index.md @@ -0,0 +1,59 @@ +--- +title: Governance +order: 1 +outline: deep +--- + +# Governance + +CobaltCore is governed under the [NeoNephos Foundation](https://neonephos.org/), a Linux Foundation initiative. Project decisions are made transparently through the structures described below. + +## Technical Steering Committee + +The Technical Steering Committee (TSC) holds all technical oversight for the project — it sets the direction, coordinates across working groups, and maintains the quality and integrity of the codebase and its processes. + +The TSC operates under the [NeoNephos project charter](https://github.com/cobaltcore-dev/.github/blob/main/GOVERNANCE.md) and makes decisions by majority vote. Amendments to the charter require a supermajority. + +**Current TSC members** + +| Name | GitHub | +|---|---| +| Artem Kovalov | [@artemkovalyov](https://github.com/artemkovalyov) | +| Andreas Uhlig | [@auhlig](https://github.com/auhlig) | +| Philipp Imhof | [@phip1611](https://github.com/phip1611) | + +TSC meetings are held regularly. Agendas and notes are published in the [`.github` repository](https://github.com/cobaltcore-dev/.github). + +## Special Interest Groups + +Special Interest Groups (SIGs) are focused working groups that own specific areas of the CobaltCore stack. Each SIG maintains its own roadmap, reviews contributions in its domain, and reports back to the TSC. + +### SIG Platform + +Owns the platform bootstrap layer — Gardener integration, GardenLinux, IronCore, and the Kubernetes control plane lifecycle. + +### SIG Compute + +Owns the compute layer — hypervisor lifecycle, KVM node agent, OpenStack Nova integration, and high-availability scheduling. + +### SIG Storage + +Owns the storage layer — Ceph, Rook, Liquid Ceph, Chorus, and the Arbiter monitor. + +### SIG Networking + +Owns the networking layer — OVN, OVS, and OpenStack Neutron integration. + +### SIG Observability + +Owns the observability stack — Prometheus, Perses, Prysm, and alerting rule coverage across the full stack. + +## Code of Conduct + +All community spaces and contributions are governed by the [NeoNephos Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md), which is based on the Contributor Covenant v3.0. Violations can be reported to [ospo@sap.com](mailto:ospo@sap.com). + +## How to get involved + +- **Contribute** — read the [contribution guidelines](https://github.com/cobaltcore-dev/.github/blob/main/CONTRIBUTING.md) and open a pull request in any repository +- **Join a SIG** — attend the relevant SIG meeting or introduce yourself in the [community channel](/community/) +- **Propose a new SIG** — open a discussion in the [`.github` repository](https://github.com/cobaltcore-dev/.github) describing the scope and initial leads From 3d8cf1214ca3823c7993b74798a29d83acadd512 Mon Sep 17 00:00:00 2001 From: Artem Kovalov Date: Mon, 9 Nov 2026 21:58:17 +0100 Subject: [PATCH 2/3] docs: remove ospo email from governance page Signed-off-by: Artem Kovalov --- docs/governance/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/governance/index.md b/docs/governance/index.md index dde7013..87ff493 100644 --- a/docs/governance/index.md +++ b/docs/governance/index.md @@ -50,7 +50,7 @@ Owns the observability stack — Prometheus, Perses, Prysm, and alerting rule co ## Code of Conduct -All community spaces and contributions are governed by the [NeoNephos Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md), which is based on the Contributor Covenant v3.0. Violations can be reported to [ospo@sap.com](mailto:ospo@sap.com). +All community spaces and contributions are governed by the [NeoNephos Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md), which is based on the Contributor Covenant v3.0. Violations can be reported per the instructions in the Code of Conduct. ## How to get involved From 2244f6156c88cc8555252342ab016cb909aaf45d Mon Sep 17 00:00:00 2001 From: Artem Kovalov Date: Mon, 9 Nov 2026 22:31:37 +0100 Subject: [PATCH 3/3] docs: ops manual, governance refinements, nav restructure - Add Operations Manual section with dedicated overview page - Move platform sub-pages (bootstrap, gardener, gardenlinux, ironcore) under operations/platform/ - Add operationsSidebar() with shared sidebar across ops routes - Add governanceSidebar() and governance page with TSC, SIGs, CoC - Move About CobaltCore and Getting Started into Documentation nav dropdown - Fix community sidebar scanning wrong root - Add docs:clean and docs:build:fresh scripts to package.json Signed-off-by: Artem Kovalov --- docs/.vitepress/config.mts | 74 +++++++++++++++---- docs/governance/index.md | 24 +++--- docs/operations/index.md | 16 ++++ docs/{ => operations}/platform/bootstrap.md | 4 +- docs/{ => operations}/platform/gardener.md | 0 docs/{ => operations}/platform/gardenlinux.md | 0 docs/{ => operations}/platform/ironcore.md | 0 package.json | 4 +- 8 files changed, 92 insertions(+), 30 deletions(-) create mode 100644 docs/operations/index.md rename docs/{ => operations}/platform/bootstrap.md (90%) rename docs/{ => operations}/platform/gardener.md (100%) rename docs/{ => operations}/platform/gardenlinux.md (100%) rename docs/{ => operations}/platform/ironcore.md (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index f681efd..2e3facc 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -113,6 +113,60 @@ function observabilitySidebar() { }; } +function operationsSidebar() { + const genSection = (scanStartPath: string, resolvePath: string) => generateSidebar([{ + documentRootPath: '/docs/', + scanStartPath, + resolvePath, + capitalizeFirst: false, + useTitleFromFrontmatter: true, + useFolderLinkFromIndexFile: true, + useFolderTitleFromIndexFile: true, + sortMenusByFrontmatterOrder: true, + }]); + + const platformItems = genSection('operations/platform', '/operations/platform/')['/operations/platform/'].items + .filter((i: any) => i.link !== 'index.md'); + const observabilityItems = genSection('observability', '/observability/')['/observability/'].items + .filter((i: any) => i.link !== 'index.md'); + const sustainabilityItems = genSection('sustainability', '/sustainability/')['/sustainability/'].items + .filter((i: any) => i.link !== 'index.md'); + + const sharedItems = [ + { + text: 'Operations Manual', + items: [ + { text: 'Overview', link: '/operations/' }, + { + text: 'Platform', + collapsed: true, + base: '/operations/platform/', + items: [{ text: 'Overview', link: '/platform/' }, ...platformItems], + }, + { + text: 'Observability', + collapsed: true, + base: '/observability/', + items: [{ text: 'Overview', link: 'index.md' }, ...observabilityItems], + }, + { + text: 'Sustainability', + collapsed: true, + base: '/sustainability/', + items: [{ text: 'Overview', link: 'index.md' }, ...sustainabilityItems], + }, + ], + }, + ]; + + return { + '/operations/': { items: sharedItems }, + '/operations/platform/': { items: sharedItems }, + '/observability/': { items: sharedItems }, + '/sustainability/': { items: sharedItems }, + }; +} + function governanceSidebar() { const generated = generateSidebar([{ documentRootPath: '/docs/', @@ -171,11 +225,11 @@ export default withMermaid({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: 'Home', link: '/' }, - { text: 'About CobaltCore', link: '/overview/' }, - { text: 'Getting Started', link: '/getting-started/' }, { text: 'Documentation', items: [ + { text: 'About CobaltCore', link: '/overview/' }, + { text: 'Getting Started', link: '/getting-started/' }, { text: 'Bare Metal Management', link: '/bare-metal/' }, { text: 'Compute', link: '/compute/' }, { text: 'Storage', link: '/storage/' }, @@ -186,7 +240,7 @@ export default withMermaid({ { text: 'Operations Manual', items: [ - { text: 'Overview', link: '/overview/' }, + { text: 'Overview', link: '/operations/' }, { text: 'Platform', link: '/platform/' }, { text: 'Observability', link: '/observability/' }, { text: 'Sustainability', link: '/sustainability/' }, @@ -244,18 +298,10 @@ export default withMermaid({ useFolderTitleFromIndexFile: true, sortMenusByFrontmatterOrder: true, }, - { - resolvePath: '/community/', - capitalizeFirst: false, - useTitleFromFrontmatter: true, - useFolderLinkFromIndexFile: true, - useFolderTitleFromIndexFile: true, - sortMenusByFrontmatterOrder: true, - }, { documentRootPath: '/docs/', - scanStartPath: 'sustainability', - resolvePath: '/sustainability/', + scanStartPath: 'community', + resolvePath: '/community/', capitalizeFirst: false, useTitleFromFrontmatter: true, useFolderLinkFromIndexFile: true, @@ -264,10 +310,10 @@ export default withMermaid({ }, ]), ...storageSidebar(), - ...observabilitySidebar(), ...networkSidebar(), ...openstackSidebar(), ...overviewSidebar(), + ...operationsSidebar(), ...governanceSidebar(), }, diff --git a/docs/governance/index.md b/docs/governance/index.md index 87ff493..7257347 100644 --- a/docs/governance/index.md +++ b/docs/governance/index.md @@ -6,11 +6,11 @@ outline: deep # Governance -CobaltCore is governed under the [NeoNephos Foundation](https://neonephos.org/), a Linux Foundation initiative. Project decisions are made transparently through the structures described below. +CobaltCore is governed and operates under the [NeoNephos Foundation](https://neonephos.org/). Project decisions are made transparently through the structures described below. ## Technical Steering Committee -The Technical Steering Committee (TSC) holds all technical oversight for the project — it sets the direction, coordinates across working groups, and maintains the quality and integrity of the codebase and its processes. +The Technical Steering Committee (TSC) holds all technical oversight for the project. It sets the direction, coordinates across working groups, and maintains the quality and integrity of the codebase and its processes. The TSC operates under the [NeoNephos project charter](https://github.com/cobaltcore-dev/.github/blob/main/GOVERNANCE.md) and makes decisions by majority vote. Amendments to the charter require a supermajority. @@ -19,8 +19,7 @@ The TSC operates under the [NeoNephos project charter](https://github.com/cobalt | Name | GitHub | |---|---| | Artem Kovalov | [@artemkovalyov](https://github.com/artemkovalyov) | -| Andreas Uhlig | [@auhlig](https://github.com/auhlig) | -| Philipp Imhof | [@phip1611](https://github.com/phip1611) | +| Michael Schmidt | [@BugRoger](https://github.com/BugRoger) | TSC meetings are held regularly. Agendas and notes are published in the [`.github` repository](https://github.com/cobaltcore-dev/.github). @@ -30,30 +29,29 @@ Special Interest Groups (SIGs) are focused working groups that own specific area ### SIG Platform -Owns the platform bootstrap layer — Gardener integration, GardenLinux, IronCore, and the Kubernetes control plane lifecycle. +Owns the platform bootstrap layer, including Gardener integration, GardenLinux, IronCore, and the Kubernetes control plane lifecycle. ### SIG Compute -Owns the compute layer — hypervisor lifecycle, KVM node agent, OpenStack Nova integration, and high-availability scheduling. +Owns the compute layer, including hypervisor lifecycle, KVM node agent, OpenStack Nova integration, and high-availability scheduling. ### SIG Storage -Owns the storage layer — Ceph, Rook, Liquid Ceph, Chorus, and the Arbiter monitor. +Owns the storage layer, including Ceph, Rook, Liquid Ceph, Chorus, and the Arbiter monitor. ### SIG Networking -Owns the networking layer — OVN, OVS, and OpenStack Neutron integration. +Owns the networking layer, including OVN, OVS, and OpenStack Neutron integration. ### SIG Observability -Owns the observability stack — Prometheus, Perses, Prysm, and alerting rule coverage across the full stack. +Owns the observability stack, including Prometheus, Perses, Prysm, and alerting rule coverage across the full stack. ## Code of Conduct -All community spaces and contributions are governed by the [NeoNephos Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md), which is based on the Contributor Covenant v3.0. Violations can be reported per the instructions in the Code of Conduct. +All community spaces and contributions are governed by the [NeoNephos Code of Conduct](https://github.com/neonephos/.github/blob/main/CODE_OF_CONDUCT.md). Violations can be reported per the instructions in the Code of Conduct. ## How to get involved -- **Contribute** — read the [contribution guidelines](https://github.com/cobaltcore-dev/.github/blob/main/CONTRIBUTING.md) and open a pull request in any repository -- **Join a SIG** — attend the relevant SIG meeting or introduce yourself in the [community channel](/community/) -- **Propose a new SIG** — open a discussion in the [`.github` repository](https://github.com/cobaltcore-dev/.github) describing the scope and initial leads +- **Join a SIG:** TBD +- **Propose a new SIG:** TBD diff --git a/docs/operations/index.md b/docs/operations/index.md new file mode 100644 index 0000000..be43a9f --- /dev/null +++ b/docs/operations/index.md @@ -0,0 +1,16 @@ +--- +title: Operations Manual +order: 1 +--- + +# Operations Manual + +The Operations Manual covers day-two operations of CobaltCore, including lifecycle management, observability, and sustainability. + +## Sections + +| Section | Description | +|---|---| +| [Platform](/platform/) | Bootstrap, Gardener, GardenLinux, and IronCore lifecycle | +| [Observability](/observability/) | Metrics, dashboards, and alerting across the full stack | +| [Sustainability](/sustainability/) | Energy efficiency and resource optimization | diff --git a/docs/platform/bootstrap.md b/docs/operations/platform/bootstrap.md similarity index 90% rename from docs/platform/bootstrap.md rename to docs/operations/platform/bootstrap.md index 44297f7..b21f9e8 100644 --- a/docs/platform/bootstrap.md +++ b/docs/operations/platform/bootstrap.md @@ -27,13 +27,13 @@ graph LR IronCore must be configured with access to your BMC (IPMI/Redfish) interfaces. Once connected, it discovers servers, collects hardware capabilities (CPU, memory, NIC topology), and makes them available as Kubernetes resources. -See [Platform - IronCore](/platform/ironcore) for configuration details. +See [Platform - IronCore](/operations/platform/ironcore) for configuration details. ## Phase 2: Cluster provisioning Gardener creates a Kubernetes cluster using the machines made available by IronCore. You define a `Shoot` resource describing the cluster topology (node count, machine type, Kubernetes version), and Gardener reconciles it. -See [Platform - Gardener](/platform/gardener) for Shoot configuration and common operations. +See [Platform - Gardener](/operations/platform/gardener) for Shoot configuration and common operations. ## Phase 3: Component installation diff --git a/docs/platform/gardener.md b/docs/operations/platform/gardener.md similarity index 100% rename from docs/platform/gardener.md rename to docs/operations/platform/gardener.md diff --git a/docs/platform/gardenlinux.md b/docs/operations/platform/gardenlinux.md similarity index 100% rename from docs/platform/gardenlinux.md rename to docs/operations/platform/gardenlinux.md diff --git a/docs/platform/ironcore.md b/docs/operations/platform/ironcore.md similarity index 100% rename from docs/platform/ironcore.md rename to docs/operations/platform/ironcore.md diff --git a/package.json b/package.json index 56368fa..8c1fe8f 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,8 @@ "scripts": { "docs:dev": "vitepress dev docs", "docs:build": "vitepress build docs", - "docs:preview": "vitepress preview docs" + "docs:preview": "vitepress preview docs", + "docs:clean": "rm -rf docs/.vitepress/cache docs/.vitepress/dist", + "docs:build:fresh": "npm run docs:clean && npm run docs:build" } }