Skip to content

Commit

Permalink
fix: API reference and liquid templating docs updated paths in makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
nickcernera committed Feb 21, 2025
1 parent 409519c commit 50f9e97
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 9 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ web: ## runs the docs site locally
sync-docs: sync-console-crd-docs sync-operator-crd-docs sync-liquid-docs

sync-console-crd-docs:
curl -L https://raw.githubusercontent.com/pluralsh/console/master/go/controller/docs/api.md --output pages/deployments/operator/api.md
curl -L https://raw.githubusercontent.com/pluralsh/console/master/go/controller/docs/api.md --output pages/01-overview/03-api-reference.md

sync-operator-crd-docs:
curl -L https://raw.githubusercontent.com/pluralsh/deployment-operator/main/docs/api.md --output pages/deployments/operator/agent-api.md
curl -L https://raw.githubusercontent.com/pluralsh/deployment-operator/main/docs/api.md --output pages/01-overview/04-agent-api.md

sync-liquid-docs:
curl -L https://raw.githubusercontent.com/pluralsh/polly/main/docs/liquid-filters.md --output pages/deployments/templating-filters.md
curl -L https://raw.githubusercontent.com/pluralsh/polly/main/docs/liquid-filters.md --output pages/03-plural-features/08-service-templating/01-templating-filters.md
2 changes: 1 addition & 1 deletion pages/01-overview/03-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API Reference
title: API Reference (Management)
description: API reference for Plural
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# API Reference
---
title: API reference (Agent)
description: API reference for Plural agent
---


## Packages
- [deployments.plural.sh/v1alpha1](#deploymentspluralshv1alpha1)
Expand Down
16 changes: 14 additions & 2 deletions src/routes/docs.generated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,16 @@ export const docRoutes: DocRouteMap = {

overview_api_reference: {
path: '/01-overview/03-api-reference',
title: 'API Reference',
title: 'API Reference (Management)',
id: 'overview_api_reference',
},

overview_agent_api: {
path: '/01-overview/04-agent-api',
title: 'API reference (Agent)',
id: 'overview_agent_api',
},

getting_started_first_steps: {
path: '/02-getting-started/01-first-steps',
title: 'First steps',
Expand Down Expand Up @@ -230,7 +236,7 @@ export const docRoutes: DocRouteMap = {

plural_features_plural_ai: {
path: '/03-plural-features/06-plural-ai',
title: 'Plural AI helper',
title: 'Plural AI',
id: 'plural_features_plural_ai',
},

Expand Down Expand Up @@ -329,6 +335,12 @@ export const docRoutes: DocRouteMap = {
title: 'Release Notes',
id: 'resources_release_notes',
},

deployments_operator_agent_api: {
path: '/deployments/operator/agent-api',
title: 'Agent API',
id: 'deployments_operator_agent_api',
},
} as const

// Type-safe route getter
Expand Down
26 changes: 24 additions & 2 deletions src/routing/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,14 @@ export const docNavigation: NavMenu = [
"sortPath": "/01-overview/02-architecture"
},
{
"title": "API Reference",
"title": "API Reference (Management)",
"href": "/overview/api-reference",
"sortPath": "/01-overview/03-api-reference"
},
{
"title": "API reference (Agent)",
"href": "/overview/agent-api",
"sortPath": "/01-overview/04-agent-api"
}
]
},
Expand Down Expand Up @@ -213,7 +218,7 @@ export const docNavigation: NavMenu = [
"sortPath": "/03-plural-features/05-kubernetes-dashboard"
},
{
"title": "Plural AI helper",
"title": "Plural AI",
"href": "/plural-features/plural-ai",
"sections": [
{
Expand Down Expand Up @@ -313,5 +318,22 @@ export const docNavigation: NavMenu = [
"sortPath": "/05-resources/01-release-notes"
}
]
},
{
"title": "Deployments",
"href": "/deployments",
"sections": [
{
"title": "Operator",
"href": "/deployments/operator",
"sections": [
{
"title": "Agent API",
"href": "/deployments/operator/agent-api",
"sortPath": "/deployments/operator/agent-api"
}
]
}
]
}
]

0 comments on commit 50f9e97

Please sign in to comment.