Skip to content

Commit

Permalink
Major Updates (#6)
Browse files Browse the repository at this point in the history
- Kubernetes Structure: Specification has been restructured into a Kubernetes API/Kind style setup (with metadata, apiVersion, kind, etc...).
- Composability: Components of a Platform have been made composable, by breaking them out into multiple Kinds (such as Platform, Network, Environment, etc).
- Documentation: Major updates and refinement, discussing the various types of Platforms (from Infrastructure Platforms, to Developer Platforms, to Services ie Control Plane Platforms).
- Dependency Updates.

---------

Co-authored-by: Jens Saade <jens@verticle.io>
  • Loading branch information
codewest and jenssaade authored Dec 3, 2024
1 parent 4a67ff7 commit 4b59a1f
Show file tree
Hide file tree
Showing 83 changed files with 3,163 additions and 2,476 deletions.
54 changes: 39 additions & 15 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import timeline from 'vitepress-markdown-timeline';
import { defineConfig } from 'vitepress'
import { defineConfig } from 'vitepress';

// https://vitepress.dev/reference/site-config
export default defineConfig({
Expand Down Expand Up @@ -46,35 +46,59 @@ export default defineConfig({
text: 'Project',
items: [
{ text: 'Preface', link: '/docs/project/preface'},
{ text: 'About The Project', link: '/docs/project/about' },
{ text: 'Contributing', link: '/docs/project/contributing' },
{ text: 'Roadmap', link: '/docs/project/roadmap' },
{ text: 'Help Wanted', link: '/docs/project/help'},
{ text: 'Authors', link: '/docs/project/authors' }
]
},
{
text: 'Background',
items: [
{ text: 'Introduction', link: '/docs/background/' },
{ text: 'What is a Cloud Platform?', link: '/docs/background/what-is-a-cloud-platform' },
{ text: 'Who needs a Cloud Platform?', link: '/docs/background/who-needs-a-cloud-platform' },
{ text: 'The Four Layers', link: '/docs/background/the-four-layers' },
{ text: 'The Six Key Pillars', link: '/docs/background/key-pillars' },
{ text: 'Stakeholders', link: '/docs/background/stakeholders' },
{ text: 'What is Platform Enginering', link: '/docs/background/platform-engineering' },
{ text: 'How Are They Related?', link: '/docs/background/cloud-platform-platform-engineering-relationship' },
]
},
{
text: 'Specification',
text: 'The Specification',
items: [
{ text: 'Overview', link: '/docs/spec/overview' },
{ text: 'Scope', link: '/docs/spec/scope' },
{ text: 'The Specification', link: '/docs/spec/spec' },
{ text: 'Example', link: '/docs/spec/example' },
{ text: 'Workflow & Usage', link: '/docs/spec/workflow-and-usage' },
{ text: 'SDKs', link: '/docs/spec/sdks' },
{ text: 'License', link: '/docs/spec/license' }
]
},
{
text: 'Platforms',
items: [
{ text: 'Types of Platforms', link: '/docs/types/types' },
{ text: 'Helpful Resources', link: '/docs/types/resources' },
{
text: 'Infrastructure Platforms',
items: [
{ text: 'What is an Infrastructure Platform?', link: '/docs/types/infrastructure/what-is-an-infrastructure-platform' },
{ text: 'Who needs an Infrastructure Platform?', link: '/docs/types/infrastructure/who-needs-an-infrastructure-platform' },
//{ text: 'Responsibilities', link: '/docs/types/infrastructure/responsibilities'},
{ text: 'The Four Layers', link: '/docs/types/infrastructure/the-four-layers' },
{ text: 'Stakeholders', link: '/docs/types/infrastructure/stakeholders' },
]
},
{
text: 'Developer Platforms',
items: [
{ text: 'What is a Developer Platform?', link: '/docs/types/developer/what-is-a-developer-platform' },
// { text: 'Who needs a Developer Platform?', link: '/docs/types/developer/who-needs-a-developer-platform' },
// { text: 'Responsibilities', link: '/docs/types/developer/responsibilities'},
// { text: 'Stakeholders', link: '/docs/types/developer/stakeholders' }
]
},
{
text: 'Services Platforms',
items: [
{ text: 'What is a Services Platform?', link: '/docs/types/services/what-is-a-services-platform' },
// { text: 'Who needs a Services Platform?', link: '/docs/types/services/who-needs-a-services-platform' },
// { text: 'Responsibilities', link: '/docs/types/services/responsibilities'},
// { text: 'Stakeholders', link: '/docs/types/services/stakeholders' }
]
}
]
}
]
},
Expand Down
2 changes: 2 additions & 0 deletions .vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ display: none !important;
--vp-home-hero-image-background-image: linear-gradient(-45deg, #99a8d8 50%, #99a8d8 50%);
--vp-home-hero-image-filter: blur(44px);
--vp-c-brand: #7579e3;
--vp-c-brand-2: #5167b1;
--vp-c-brand-3: #3451b2;
--timeline-title-text: black;
}

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FROM node:22.8-alpine

WORKDIR /app

RUN npm install vitepress@1.3.4
RUN npm install vitepress@1.5.0

EXPOSE 5173

Expand Down
7 changes: 0 additions & 7 deletions blueprints.md

This file was deleted.

2 changes: 1 addition & 1 deletion community.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Platform Specification is just getting started, and we’re currently at **v
- **Grow Your Skills:** Contributing to the Platform Specification is a great way to expand your knowledge and skills in cloud platform engineering and architecture.

**How to Get Involved:**
- **Join the Discussion:** Participate in our community forums, GitHub discussions, and virtual meetups.
- **Involvement:** See the [Involvement](./docs/project/contributing) page for details.
- **Contribute Code and Ideas:** Help us refine the specification by submitting code, documentation, or simply sharing your thoughts and feedback.
- **Stay Updated:** Follow our progress, get involved in our roadmap planning, and be the first to know about new features and updates.

Expand Down
70 changes: 0 additions & 70 deletions docs/background/index.md

This file was deleted.

Loading

0 comments on commit 4b59a1f

Please sign in to comment.