Skip to content

Commit

Permalink
Additions to site: (#2)
Browse files Browse the repository at this point in the history
* Project Roadmap
* News and Announcements
* Sitemap
* Image adjustments
* Vitepress Timeline Plugin
  • Loading branch information
codewest authored Nov 3, 2024
1 parent 55e96d0 commit aa74abd
Show file tree
Hide file tree
Showing 9 changed files with 95 additions and 13 deletions.
12 changes: 11 additions & 1 deletion .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import timeline from 'vitepress-markdown-timeline';
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
Expand All @@ -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: {
Expand All @@ -17,16 +26,17 @@ export default defineConfig({
nav: [
{ text: 'Home', link: '/' },
{ text: 'Documentation', link: '/docs/project/preface/' },
{ text: 'News', link: '/news'},
{ text: 'Community', link: '/community' }
],

sidebar: {
'/docs/': [
{
text: 'Project',
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' }
]
Expand Down
24 changes: 13 additions & 11 deletions .vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}
}
11 changes: 10 additions & 1 deletion .vitepress/theme/index.js
Original file line number Diff line number Diff line change
@@ -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
//export default DefaultTheme

export default {
...Theme,
enhanceApp(ctx) {
Theme.enhanceApp(ctx);
},
};
19 changes: 19 additions & 0 deletions docs/project/roadmap.md
Original file line number Diff line number Diff line change
@@ -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`.
21 changes: 21 additions & 0 deletions news.md
Original file line number Diff line number Diff line change
@@ -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.

<p>&nbsp;</p>

::: 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.
:::
18 changes: 18 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@
"docs:dev": "vitepress dev",
"docs:build": "vitepress build",
"docs:preview": "vitepress preview"
},
"dependencies": {
"vitepress-markdown-timeline": "^1.2.1"
}
}
Binary file modified public/workflow-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/workflow-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa74abd

Please sign in to comment.