chore(*): update entity docs link

Kong · Sep 8, 2023 · 76da8a8 · 76da8a8
1 parent 62dd4a3
commit 76da8a8
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 21 deletions.
diff --git a/src/composables/useDocsLink.ts b/src/composables/useDocsLink.ts
@@ -3,23 +3,22 @@ import { formatVersion } from '@/utils'
 import { config } from 'config'
 
 export const useDocsLink = (entity: string) => {
+  const edition = config.GATEWAY_EDITION ?? 'community'
   const version = computed(() => {
     if (!config.GATEWAY_VERSION) {
       return 'latest'
     }
 
-    return `${formatVersion(config.GATEWAY_VERSION)}.x`
+    return edition === 'enterprise'
+      // For Enterprise, the version has a pattern of <major>.<minor>.0.x where the 3rd digit
+      // will always be 0 regardless of the actual patch version
+      ? `${formatVersion(config.GATEWAY_VERSION)}.0.x`
+      // For OSS, the version has a pattern of <major>.<minor>.x
+      : `${formatVersion(config.GATEWAY_VERSION)}.x`
   })
 
-  const docsBase = computed(() => `https://docs.konghq.com/gateway/${version.value}/admin-api`)
-  const docsLink = computed(() => {
-    switch (entity) {
-      case 'key-set':
-        return `${docsBase.value}/#key-sets-entity`
-      default:
-        return `${docsBase.value}/#${entity}-object`
-    }
-  })
+  const docsBase = computed(() => `https://docs.konghq.com/gateway/api/admin-${edition === 'enterprise' ? 'ee' : 'oss'}/${version.value}/#/`)
+  const docsLink = computed(() => `${docsBase.value}${entity}`)
 
   return docsLink
 }
diff --git a/src/pages/ca-certificates/List.vue b/src/pages/ca-certificates/List.vue
@@ -38,7 +38,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('ca-certificate')
+const docsLink = useDocsLink('CA Certificates')
 
 const createRoute = computed(() => {
   return { name: 'ca-certificate-create' }

diff --git a/src/pages/certificates/List.vue b/src/pages/certificates/List.vue
@@ -38,7 +38,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('certificate')
+const docsLink = useDocsLink('Certificates')
 
 const createRoute = computed(() => {
   return { name: 'certificate-create' }

diff --git a/src/pages/consumers/List.vue b/src/pages/consumers/List.vue
@@ -39,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('consumer')
+const docsLink = useDocsLink('Consumers')
 
 const createRoute = computed(() => {
   return { name: 'consumer-create' }

diff --git a/src/pages/key-sets/List.vue b/src/pages/key-sets/List.vue
@@ -39,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('key-set')
+const docsLink = useDocsLink('Key-sets')
 
 const filterSchema = computed<FilterSchema>(() => {
   return {

diff --git a/src/pages/keys/List.vue b/src/pages/keys/List.vue
@@ -45,7 +45,7 @@ const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const route = useRoute()
 const { t } = useI18n()
-const docsLink = useDocsLink('keys')
+const docsLink = useDocsLink('Keys')
 
 const keySetId = computed(() => (route.params?.id ?? '') as string)
 const cacheIdentifier = computed(() => `routes-${keySetId.value}`)

diff --git a/src/pages/plugins/List.vue b/src/pages/plugins/List.vue
@@ -47,7 +47,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('plugin')
+const docsLink = useDocsLink('Plugins')
 const route = useRoute()
 const cacheIdentifier = computed(() => `plugins-${route.params?.id}`)
 const entityType = computed(() => route.meta?.scopedIn as EntityType)

diff --git a/src/pages/routes/List.vue b/src/pages/routes/List.vue
@@ -42,7 +42,7 @@ defineOptions({ name: 'RouteList' })
 const toaster = useToaster()
 const route = useRoute()
 const { t } = useI18n()
-const docsLink = useDocsLink('route')
+const docsLink = useDocsLink('Routes')
 const { createRedirectRouteQuery } = useListRedirect()
 
 const serviceId = computed(() => (route.params?.id ?? '') as string)

diff --git a/src/pages/services/List.vue b/src/pages/services/List.vue
@@ -39,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('service')
+const docsLink = useDocsLink('Services')
 
 const createRoute = computed(() => {
   return { name: 'service-create' }

diff --git a/src/pages/snis/List.vue b/src/pages/snis/List.vue
@@ -39,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('sni')
+const docsLink = useDocsLink('SNIs')
 
 const createRoute = computed(() => {
   return { name: 'sni-create' }

diff --git a/src/pages/upstreams/List.vue b/src/pages/upstreams/List.vue
@@ -39,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('upstream')
+const docsLink = useDocsLink('Upstreams')
 
 const createRoute = computed(() => {
   return { name: 'upstream-create' }

diff --git a/src/pages/vaults/List.vue b/src/pages/vaults/List.vue
@@ -39,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('vaults')
+const docsLink = useDocsLink('Vaults')
 
 const createRoute = computed(() => {
   return { name: 'vault-create' }