From 444fffb5c8db45a29dfc36aa3e4470d0d21cb49b Mon Sep 17 00:00:00 2001 From: "Japheth Louie M. Gofredo" <83058948+japhethLG@users.noreply.github.com> Date: Sat, 9 Nov 2024 01:33:24 +0800 Subject: [PATCH] feat: docs redirects (#2488) # Description Redirects zesty docs to readme Fixes #2487 ## Type of change Please delete options that are not relevant. - [x] New feature (non-breaking change which adds functionality) # How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. - [x] Manual Test # Screenshots / Screen recording https://github.com/user-attachments/assets/05a4fb40-231b-41e1-9a5c-46288f1b06d2 --------- Signed-off-by: Japheth Louie M. Gofredo <83058948+japhethLG@users.noreply.github.com> --- .vscode/settings.json | 2 +- next.config.js | 5 +++++ src/config/redirects.js | 49 +++++++++++++++++++++++++++++++++++++++++ src/pages/docs/index.js | 6 ++--- 4 files changed, 58 insertions(+), 4 deletions(-) create mode 100644 src/config/redirects.js diff --git a/.vscode/settings.json b/.vscode/settings.json index 5f21e24fb..278c412c5 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,5 +4,5 @@ "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.codeActionsOnSave": { "source.fixAll.format": "never" - } + }, } diff --git a/next.config.js b/next.config.js index 77288aee4..4c398e613 100644 --- a/next.config.js +++ b/next.config.js @@ -1,4 +1,5 @@ const zestyConfig = require('./zesty.config.json'); +const { docsRedirects } = require('./src/config/redirects'); module.exports = { trailingSlash: true, @@ -14,4 +15,8 @@ module.exports = { ], }, swcMinify: true, + + async redirects() { + return [...docsRedirects]; + }, }; diff --git a/src/config/redirects.js b/src/config/redirects.js new file mode 100644 index 000000000..c27a3184d --- /dev/null +++ b/src/config/redirects.js @@ -0,0 +1,49 @@ +const docsRedirects = [ + { + source: '/docs/instances/api-reference/:path*', + destination: 'https://docs.zesty.io/reference/instances-api-reference', + permanent: true, + }, + { + source: '/docs/authentication/api-reference/:path*', + destination: 'https://docs.zesty.io/reference/authentication-api-reference', + permanent: true, + }, + { + source: '/docs/accounts/api-reference/:path*', + destination: 'https://docs.zesty.io/reference/accounts-api-reference', + permanent: true, + }, + { + source: '/docs/parsley/api-reference/:path*', + destination: 'https://docs.zesty.io/docs/parsley', + permanent: true, + }, + { + source: '/docs/media/api-reference/:path*', + destination: 'https://docs.zesty.io/reference/media-api-reference', + permanent: true, + }, + { + source: '/docs/media/api-reference/manager/:path*', + destination: 'https://docs.zesty.io/reference/media-manager-api-reference', + permanent: true, + }, + { + source: '/docs/media/api-reference/storage/:path*', + destination: 'https://docs.zesty.io/reference/media-storage-api-reference', + permanent: true, + }, + { + source: '/docs/media/api-reference/modify/:path*', + destination: 'https://docs.zesty.io/reference/media-modify-api-reference', + permanent: true, + }, + { + source: '/docs/media/api-reference/resolver/:path*', + destination: 'https://docs.zesty.io/reference/media-resolver-api-reference', + permanent: true, + }, +]; + +module.exports = { docsRedirects }; diff --git a/src/pages/docs/index.js b/src/pages/docs/index.js index 76b6c95f5..4dfa00c8c 100644 --- a/src/pages/docs/index.js +++ b/src/pages/docs/index.js @@ -165,19 +165,19 @@ const cardData = [ title: 'Instances API', description: 'A collection of available REST endpoints scoped to your unique instance.', - link: '/docs/instances/api-reference/', + link: 'https://docs.zesty.io/reference/instances-api-reference', }, { title: 'Authentication API', description: 'Auth API is used to authenticate users with Zesty.io, which returns a token that grants to access services like Instances API, Accounts API, and Media API. Auth was setup as a stand alone service so it can connect to many services in our infrastructure.', - link: '/docs/authentication/api-reference/', + link: 'https://docs.zesty.io/reference/authentication-api-reference', }, { title: 'Accounts API', description: 'API used to control management of users, roles, instances, and teams.', - link: '/docs/accounts/api-reference/', + link: 'https://docs.zesty.io/reference/accounts-api-reference', }, { title: 'Guides',