Skip to content

Fix References redirects #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 3, 2025
Merged

Fix References redirects #289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96b527e
Fix References redirects (part 1?)
cap10morgan Sep 2, 2025
eb959b0
Redirect all /docs/technical-details/reference/* paths
cap10morgan Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions redirects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,15 @@ function generateDocsRedirects(basePath: string): RedirectRule[] {
{ from: withBase('/audit-logging'), to: withBase('/administration/logging/audit-logging') },
{ from: withBase('/jobs'), to: withBase('/administration/jobs') },
{ from: withBase('/upgrade-hdb-instance'), to: withBase('/deployments/upgrade-hdb-instance') },
{ from: withBase('/reference'), to: withBase('/reference/') },
{ from: withBase('/operations-api'), to: withBase('/developers/operations-api/') },
{ from: withBase('/rest'), to: withBase('/developers/rest') },
{ from: withBase('/api'), to: withBase('/developers/operations-api/') },

// File rename redirect
{ from: withBase('/administration/logging/logging'), to: withBase('/administration/logging/standard-logging') }
{ from: withBase('/administration/logging/logging'), to: withBase('/administration/logging/standard-logging') },

// Old Technical Details -> Reference paths
{ from: withBase('/technical-details/reference'), to: withBase('/reference/') }
);

return redirects;
Expand Down Expand Up @@ -264,12 +266,19 @@ export function createRedirects(existingPath: string, basePath: string = ''): st
}
}

// Old Technical Details -> Reference paths
if (existingPath.startsWith(`${basePath}/reference/`)) {
const subpath = existingPath.replace(`${basePath}/reference/`, '');
if (subpath) {
redirects.push(`${basePath}/technical-details/reference/${subpath}`);
}
}

// Don't create wildcard redirects for these as they're all explicitly defined:
// - /developers/security/* (all subpaths are explicit)
// - /deployments/harper-cli (explicit)
// - /developers/sql-guide/* (has explicit redirect)
// - /developers/operations-api/* (has explicit redirects)
// - /reference/* (has explicit redirect)

return redirects.length > 0 ? redirects : undefined;
}