Skip to content

Commit

Permalink
updated migration
Browse files Browse the repository at this point in the history
  • Loading branch information
ntotten committed Dec 19, 2024
1 parent 67ffcba commit 81c459c
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 9 deletions.
8 changes: 8 additions & 0 deletions docs/dev-portal/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: Introduction
---

:::warning

This documentation is for the preview version of the Dev Portal. If you are not
part of the preview program, please refer to the
[current Dev Portal docs](/docs/articles/developer-portal).

:::

Welcome to the preview release of Zuplo's new Developer Portal powered by
[Zudoku](https://zudoku.dev)!

Expand Down
34 changes: 30 additions & 4 deletions docs/dev-portal/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ title: Dev Portal Migration Guide
sidebar_label: Migration Guide
---

:::warning

This documentation is for the preview version of the Dev Portal. If you are not
part of the preview program, please refer to the
[current Dev Portal docs](/docs/articles/developer-portal).

:::

This guide is intended to help you migrate your existing documentation from the
current Dev Portal to the new Dev Portal powered by Zudoku.

Expand Down Expand Up @@ -89,11 +97,11 @@ const config: ZudokuConfig = {
{
type: "category",
label: "Overview",
items: ["example", "other-example"],
items: ["introduction", "other-example"],
},
],
},
redirects: [{ from: "/", to: "/documentation" }],
redirects: [{ from: "/", to: "/introduction" }],
apis: {
type: "file",
input: "../config/routes.oas.json",
Expand Down Expand Up @@ -122,8 +130,9 @@ subdirectories under this as needed.
You will need to create a `tsconfig.json` and `package.json` file in the `docs`
folder. You can copy these two files below.

**`tsconfig.json`**

```json
// tsconfig.json
{
"compilerOptions": {
"target": "ES2022",
Expand All @@ -136,13 +145,15 @@ folder. You can copy these two files below.
"resolveJsonModule": true,
"isolatedModules": true,
"useUnknownInCatchVariables": false,
"types": ["zudoku/client"],
"jsx": "react-jsx"
}
}
```

**`package.json`**

```json
// package.json
{
"name": "docs",
"version": "0.1.0",
Expand All @@ -165,3 +176,18 @@ folder. You can copy these two files below.
}
}
```

### Theme

For instructions on theming the dev portal, see
[customizing](./zudoku/configuration/customization.md).

Additional theming is possible. More documentation is coming soon.

## Cleanup

Make sure to delete the following files after you are done with the migration:

- `/config/dev-portal.json`
- `/docs/sidebar.json`
- `/docs/theme.css`
8 changes: 4 additions & 4 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"react-dom": "18.3.1",
"safe-marked": "16.0.0",
"typescript": "5.6.3",
"zudoku": "0.21.5"
"zudoku": "^0.21.9"
},
"devDependencies": {
"@types/json-schema": "7.0.15",
Expand Down

0 comments on commit 81c459c

Please sign in to comment.