diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 2d25739..ee0ff59 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -1,3 +1,4 @@ +import timeline from 'vitepress-markdown-timeline'; import { defineConfig } from 'vitepress' // https://vitepress.dev/reference/site-config @@ -7,6 +8,14 @@ export default defineConfig({ head: [ [ 'script', { defer: '', 'data-domain': 'platformspec.io', src: 'https://plausible.io/js/script.js' } ] ], + sitemap: { + hostname: 'https://platformspec.io' + }, + markdown: { + config: (md) => { + md.use(timeline); + }, + }, themeConfig: { // https://vitepress.dev/reference/default-theme-config logo: { @@ -17,9 +26,9 @@ export default defineConfig({ nav: [ { text: 'Home', link: '/' }, { text: 'Documentation', link: '/docs/project/preface/' }, + { text: 'News', link: '/news'}, { text: 'Community', link: '/community' } ], - sidebar: { '/docs/': [ { @@ -27,6 +36,7 @@ export default defineConfig({ items: [ { text: 'Preface', link: '/docs/project/preface'}, { 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' } ] diff --git a/.vitepress/theme/custom.css b/.vitepress/theme/custom.css index ef82d1e..6e5cdde 100644 --- a/.vitepress/theme/custom.css +++ b/.vitepress/theme/custom.css @@ -11,16 +11,18 @@ display: none !important; --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #3451b2 30%, #8596d0); --vp-home-hero-image-background-image: linear-gradient(-45deg, #99a8d8 50%, #99a8d8 50%); --vp-home-hero-image-filter: blur(44px); + --vp-c-brand: #7579e3; + --timeline-title-text: black; +} + +@media (min-width: 640px) { + :root { + --vp-home-hero-image-filter: blur(56px); } - - @media (min-width: 640px) { - :root { - --vp-home-hero-image-filter: blur(56px); - } +} + +@media (min-width: 960px) { + :root { + --vp-home-hero-image-filter: blur(68px); } - - @media (min-width: 960px) { - :root { - --vp-home-hero-image-filter: blur(68px); - } - } \ No newline at end of file +} diff --git a/.vitepress/theme/index.js b/.vitepress/theme/index.js index bed9095..711029a 100644 --- a/.vitepress/theme/index.js +++ b/.vitepress/theme/index.js @@ -1,5 +1,14 @@ // .vitepress/theme/index.js import DefaultTheme from 'vitepress/theme' +import Theme from "vitepress/theme"; import './custom.css' +import "vitepress-markdown-timeline/dist/theme/index.css"; -export default DefaultTheme \ No newline at end of file +//export default DefaultTheme + +export default { + ...Theme, + enhanceApp(ctx) { + Theme.enhanceApp(ctx); + }, + }; \ No newline at end of file diff --git a/docs/project/roadmap.md b/docs/project/roadmap.md new file mode 100644 index 0000000..2caa75c --- /dev/null +++ b/docs/project/roadmap.md @@ -0,0 +1,19 @@ +# Roadmap +See where The Platform Specification is headed with our transparent roadmap. + +## Current Priorities + +* Designing the "Policies" section of The Platform Specification. + +## Next Priorities + +* Designing the "Governance and Compliance" section of The Platform Specification. +* Designing the "Developer Services & Enablement" section of The Platform Spefification. +* Designing the "Observability & Performance" section of The Platform Specification. +* SDK -- Golang Platform Specification Model Library. +* SDK -- Python Platform Specification Model Library. +* Example Platform definitions, with diagrams and descriptions. + +## Future Priorities + +* Interactive UI based platform designer; renders out a `platform.yaml`. \ No newline at end of file diff --git a/news.md b/news.md new file mode 100644 index 0000000..d31833c --- /dev/null +++ b/news.md @@ -0,0 +1,21 @@ +--- +layout: doc +sidebar: false +aside: false +--- + +# News and Announcements + +Stay up-to-date on all things Platform Specification. This is where you'll find the latest news, releases, and announcements about The Platform Specification project. + +

 

+ +::: timeline November 2nd, 2024 +::: info Roadmap Published! +We're thrilled to announce the launch of The Platform Specification's official roadmap. This roadmap outlines our key priorities and goals for the coming months and years, ensuring transparency and alignment with the needs of our users. We'll be developing new tools, expanding the specification examples, deepening community engagement, and and publishing Platform Blueprints. Access the full roadmap and contribute your thoughts on the [Roadmap](docs/project/roadmap) page within the documentation. +::: + +::: timeline October 28th, 2024 +::: info The Platform Specification launched! +We're excited to announce the launch of The Platform Specification's official website! This central hub provides a comprehensive resource for all things related to The Platform Specification, including detailed documentation, examples, and information about getting involved. +::: diff --git a/package-lock.json b/package-lock.json index a947d0a..f08f19a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4,6 +4,9 @@ "requires": true, "packages": { "": { + "dependencies": { + "vitepress-markdown-timeline": "^1.2.1" + }, "devDependencies": { "vitepress": "^1.4.2" } @@ -1724,6 +1727,12 @@ "dev": true, "license": "MIT" }, + "node_modules/dayjs": { + "version": "1.11.13", + "resolved": "https://registry.npmjs.org/dayjs/-/dayjs-1.11.13.tgz", + "integrity": "sha512-oaMBel6gjolK862uaPQOVTA7q3TZhuSvuMQAAglQDOWYO9A91IrAOUJEyKVlqJlHE0vq5p5UXxzdPfMH/x6xNg==", + "license": "MIT" + }, "node_modules/dequal": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", @@ -2499,6 +2508,15 @@ } } }, + "node_modules/vitepress-markdown-timeline": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/vitepress-markdown-timeline/-/vitepress-markdown-timeline-1.2.1.tgz", + "integrity": "sha512-XPYl/btTcTzW+XF20ITB51L8jPjbS72tSKPcv/CHJgM+3LbBvW8Az/X7RcBTJSXDNOwCY5mGkjA7CXQtuxOKgw==", + "license": "MIT", + "dependencies": { + "dayjs": "^1.11.7" + } + }, "node_modules/vue": { "version": "3.5.12", "resolved": "https://registry.npmjs.org/vue/-/vue-3.5.12.tgz", diff --git a/package.json b/package.json index 391ea57..960fdb4 100644 --- a/package.json +++ b/package.json @@ -6,5 +6,8 @@ "docs:dev": "vitepress dev", "docs:build": "vitepress build", "docs:preview": "vitepress preview" + }, + "dependencies": { + "vitepress-markdown-timeline": "^1.2.1" } } diff --git a/public/workflow-dark.png b/public/workflow-dark.png index 96c321e..647c7cc 100644 Binary files a/public/workflow-dark.png and b/public/workflow-dark.png differ diff --git a/public/workflow-light.png b/public/workflow-light.png index 66c4539..4385a61 100644 Binary files a/public/workflow-light.png and b/public/workflow-light.png differ