Skip to content

Commit

Permalink
feat: docs redirects (#2488)
Browse files Browse the repository at this point in the history
# 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 <[email protected]>
  • Loading branch information
japhethLG committed Nov 22, 2024
1 parent 2193c76 commit 1da4e99
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.codeActionsOnSave": {
"source.fixAll.format": "never"
}
},
}
5 changes: 5 additions & 0 deletions next.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
const zestyConfig = require('./zesty.config.json');
const { docsRedirects } = require('./src/config/redirects');

module.exports = {
trailingSlash: true,
Expand All @@ -14,4 +15,8 @@ module.exports = {
],
},
swcMinify: true,

async redirects() {
return [...docsRedirects];
},
};
49 changes: 49 additions & 0 deletions src/config/redirects.js
Original file line number Diff line number Diff line change
@@ -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 };
6 changes: 3 additions & 3 deletions src/pages/docs/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit 1da4e99

Please sign in to comment.