Skip to content
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.

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

fix: incorrect editUrl for versioned docs #704

Merged
merged 1 commit into from
Nov 4, 2021
Merged
Changes from all commits
Commits
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
88 changes: 77 additions & 11 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
const { ssrTemplate } = require('./config/ssrTemplate');

const getEditUrl = ({
projectName,
version,
locale,
docPath,
defaultBranch = "master"
}) => {
const branch = version === 'current' ? defaultBranch : `release/${version}`;
return `https://github.com/apache/${projectName}/edit/${branch}/docs/${locale}/latest/${docPath}`;
}

module.exports = {
title: "Apache APISIX® -- Cloud-Native API Gateway",
tagline:
Expand Down Expand Up @@ -293,11 +304,16 @@ module.exports = {
routeBasePath: "/docs/apisix",
sidebarPath: require.resolve("./docs/apisix/sidebars.json"),
editUrl: function ({
locale,
docPath,
version,
locale
}) {
// TODO: support Edit on multiple versions/branches
return `https://github.com/apache/apisix/edit/master/docs/${locale}/latest/${docPath}`;
return getEditUrl({
projectName: "apisix",
locale,
docPath,
version
})
},
},
],
Expand All @@ -312,8 +328,15 @@ module.exports = {
sidebarPath: require.resolve("./docs/apisix-dashboard/sidebars.json"),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-dashboard/edit/master/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-dashboard",
locale,
docPath,
version
})
},
},
],
Expand All @@ -330,8 +353,15 @@ module.exports = {
),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-ingress-controller/edit/master/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-ingress-controller",
locale,
docPath,
version
})
},
},
],
Expand All @@ -346,8 +376,15 @@ module.exports = {
sidebarPath: require.resolve("./docs/apisix-helm-chart/sidebars.json"),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-helm-chart/edit/master/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-helm-chart",
locale,
docPath,
version
})
},
},
],
Expand All @@ -362,8 +399,15 @@ module.exports = {
sidebarPath: require.resolve("./docs/apisix-docker/sidebars.json"),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-docker/edit/master/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-docker",
locale,
docPath,
version
})
},
},
],
Expand All @@ -378,8 +422,16 @@ module.exports = {
sidebarPath: require.resolve("./docs/apisix-java-plugin-runner/sidebars.json"),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-java-plugin-runner/edit/main/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-java-plugin-runner",
locale,
docPath,
version,
defaultBranch: "main"
})
},
},
],
Expand All @@ -394,8 +446,15 @@ module.exports = {
sidebarPath: require.resolve("./docs/apisix-go-plugin-runner/sidebars.json"),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-go-plugin-runner/edit/master/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-go-plugin-runner",
locale,
docPath,
version,
})
},
},
],
Expand All @@ -410,8 +469,15 @@ module.exports = {
sidebarPath: require.resolve("./docs/apisix-python-plugin-runner/sidebars.json"),
editUrl: function ({
docPath,
version,
locale
}) {
return `https://github.com/apache/apisix-python-plugin-runner/edit/master/docs/en/latest/${docPath}`;
return getEditUrl({
projectName: "apisix-python-plugin-runner",
locale,
docPath,
version,
})
},
},
],
Expand Down Expand Up @@ -647,5 +713,5 @@ module.exports = {
* We need to check if we build site for preview env, or preview site will load static assets from the asf-site branch.
* See ssrTemplate -> jsDelivr
*/
ssrTemplate
ssrTemplate
};