@f5-sales-demo/docs-theme 4.13.14 → 4.13.16

package/components/Banner.astro

@@ -6,15 +6,18 @@ const { sidebar, entry, siteTitle, editUrl } = Astro.locals.starlightRoute;
 const t = Astro.locals.t;
 
 const isIndexPage = entry.filePath ? /(?:^|[\\/])index\.mdx?$/.test(entry.filePath) : false;
-const hideBreadcrumbs = isIndexPage;
+const certificateManagement = import.meta.env.F5_DOCS_REPOSITORY === 'f5-sales-demo/certificate-management';
+const hideBreadcrumbs = isIndexPage && !certificateManagement;
 
-function findTrail(entries: typeof sidebar, trail: { label: string }[] = []): { label: string }[] | null {
+function findTrail(entries: typeof sidebar, trail: { label: string; href?: string }[] = []): { label: string; href?: string }[] | null {
   for (const item of entries) {
     if (item.type === 'link' && item.isCurrent) {
       return trail;
     }
     if (item.type === 'group') {
-      const result = findTrail(item.entries, [...trail, { label: item.label }]);
+      const overview = item.entries.find((child) => child.type === 'link');
+      const href = certificateManagement && overview?.type === 'link' ? overview.href : undefined;
+      const result = findTrail(item.entries, [...trail, { label: item.label, href }]);
       if (result) return result;
     }
   }
@@ -32,9 +35,9 @@ const fixedEditUrl = editUrl ? editUrl.href.replace('/src/content/docs/', '/docs
       <li><a href={docsHome}>{t('f5xc.breadcrumb.home')}</a></li>
       <li><a href={import.meta.env.BASE_URL}>{siteTitle}</a></li>
       {trail.map((crumb) => (
-        <li><span>{crumb.label}</span></li>
+        <li>{crumb.href ? <a href={crumb.href}>{crumb.label}</a> : <span>{crumb.label}</span>}</li>
       ))}
-      <li aria-current="page"><span>{entry.data.title}</span></li>
+      <li aria-current="page"><span>{certificateManagement ? entry.data.sidebar?.label || entry.data.title : entry.data.title}</span></li>
     </ol>
     {fixedEditUrl && (
       <a href={fixedEditUrl} target="_blank" rel="noopener noreferrer" class="edit-link">

package/config.ts

@@ -409,6 +409,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
     site,
     base,
     vite: {
+      define: { 'import.meta.env.F5_DOCS_REPOSITORY': JSON.stringify(githubRepository) },
       plugins: mode === 'local' ? [menuLocalizationPolicy()] : [sharedSearchIntegration()],
       ...(canonicalProvider ? { build: { assetsInlineLimit: 0 } } : {}),
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.13.14",
+  "version": "4.13.16",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {

package/route-middleware.ts

@@ -2,16 +2,12 @@ import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 import { defineRouteMiddleware } from '@astrojs/starlight/route-data';
 import { itemLabels, menuLabels } from './src/i18n/mega-menu-translations.ts';
 import { isCanonicalReference } from './src/utils/canonical-provider.ts';
+import { suppressIndexToc } from './src/utils/index-toc.ts';
 
 const titleTranslations: Record<string, Record<string, string>> = { ...menuLabels, ...itemLabels };
 
 type SidebarEntry = StarlightRouteData['sidebar'][number];
 
-function isIndexPage(filePath: string | undefined): boolean {
-  if (!filePath) return false;
-  return /(?:^|[\\/])index\.mdx?$/.test(filePath);
-}
-
 function hrefToSlug(href: string): string {
   const base = import.meta.env.BASE_URL.replace(/\/$/, '');
   let s = href;
@@ -56,12 +52,12 @@ export const onRequest = defineRouteMiddleware(async (context, next) => {
   const route = context.locals.starlightRoute;
   const entry = route.entry;
 
-  if (!isCanonicalReference(entry.data) && isIndexPage(entry.filePath)) {
-    // Unconditionally hide TOC on index pages
+  const repository = import.meta.env.F5_DOCS_REPOSITORY || '';
+  if (!isCanonicalReference(entry.data) && suppressIndexToc(repository, entry.filePath, entry.data.tableOfContents)) {
     route.toc = undefined;
   }
 
-  if (indexSlugs.size > 0) {
+  if (repository !== 'f5-sales-demo/certificate-management' && indexSlugs.size > 0) {
     route.sidebar = filterIndexPages(route.sidebar, indexSlugs);
   }
 

package/src/utils/index-toc.ts

@@ -0,0 +1,5 @@
+/** Preserve legacy index behavior except for the explicitly selected repository. */
+export function suppressIndexToc(repository: string, filePath: string | undefined, tableOfContents: unknown): boolean {
+  if (tableOfContents === false) return true;
+  return repository !== 'f5-sales-demo/certificate-management' && /(?:^|[\\/])index\.mdx?$/.test(filePath ?? '');
+}

package/src/utils/publication-profiles.ts

@@ -11,6 +11,93 @@ interface PublicationProfile {
 
 /** Repository publication decisions shared by navigation and site configuration. */
 export const publicationProfiles: Record<string, PublicationProfile> = {
+  'certificate-management': {
+    locales: { en: { label: 'English', lang: 'en' } },
+    defaultLocale: 'en',
+    sidebar: [
+      { label: 'Overview', slug: 'index' },
+      {
+        label: 'xcsh',
+        collapsed: false,
+        items: [
+          { label: 'Overview', slug: 'xcsh' },
+          { label: 'Prerequisites', slug: 'xcsh/prerequisites' },
+          { label: 'Configuration', slug: 'xcsh/configuration' },
+          { label: 'Configure', slug: 'xcsh/configure' },
+          { label: 'Verify', slug: 'xcsh/verify' },
+          { label: 'Maintain', slug: 'xcsh/maintain' },
+          { label: 'Remove', slug: 'xcsh/remove' },
+          { label: 'Input variants', slug: 'xcsh/input-workflows' },
+          { label: 'Command reference', slug: 'xcsh/command-reference' },
+        ],
+      },
+      {
+        label: 'Terraform',
+        collapsed: false,
+        items: [
+          { label: 'Overview', slug: 'terraform' },
+          { label: 'Prerequisites', slug: 'terraform/prerequisites' },
+          { label: 'Configuration', slug: 'terraform/configuration' },
+          { label: 'Configure', slug: 'terraform/configure' },
+          { label: 'Verify', slug: 'terraform/verify' },
+          { label: 'Maintain', slug: 'terraform/maintain' },
+          { label: 'Remove', slug: 'terraform/remove' },
+          { label: 'Inputs and lifecycle', slug: 'terraform/input-lifecycle' },
+          { label: 'Qualification campaign', slug: 'terraform/campaign' },
+          {
+            label: 'Certificate types',
+            collapsed: true,
+            items: [
+              { label: 'Choose configuration', slug: 'terraform/certificate-surfaces' },
+              { label: 'Advertise TLS', slug: 'terraform/certificate-surfaces/advertise-tls' },
+              { label: 'CDN origin mTLS', slug: 'terraform/certificate-surfaces/cdn-origin-mtls' },
+              { label: 'CDN server TLS', slug: 'terraform/certificate-surfaces/cdn-server-tls' },
+              { label: 'Cluster TLS', slug: 'terraform/certificate-surfaces/cluster-tls' },
+              { label: 'Default pool mTLS', slug: 'terraform/certificate-surfaces/http-origin-mtls' },
+              { label: 'Inline server TLS', slug: 'terraform/certificate-surfaces/inline-server-tls' },
+              { label: 'Origin mTLS', slug: 'terraform/certificate-surfaces/origin-mtls' },
+              { label: 'TLS interception', slug: 'terraform/certificate-surfaces/proxy-intercept' },
+              { label: 'Proxy TLS', slug: 'terraform/certificate-surfaces/proxy-tls' },
+              { label: 'Secret access TLS', slug: 'terraform/certificate-surfaces/secret-access-tls' },
+              { label: 'TCP TLS', slug: 'terraform/certificate-surfaces/tcp-tls' },
+              { label: 'Virtual host TLS', slug: 'terraform/certificate-surfaces/virtual-host-tls' },
+              { label: 'Custom workload TLS', slug: 'terraform/certificate-surfaces/workload-service-custom' },
+              { label: 'Multiport workload TLS', slug: 'terraform/certificate-surfaces/workload-service-public-multi' },
+              { label: 'Workload TLS', slug: 'terraform/certificate-surfaces/workload-service-public-single' },
+            ],
+          },
+        ],
+      },
+      {
+        label: 'Client mTLS',
+        collapsed: false,
+        items: [
+          { label: 'Overview', slug: 'client-mtls' },
+          { label: 'Prerequisites', slug: 'client-mtls/prerequisites' },
+          { label: 'Configuration', slug: 'client-mtls/configuration' },
+          { label: 'Configure', slug: 'client-mtls/configure' },
+          { label: 'Verify', slug: 'client-mtls/verify' },
+          { label: 'Maintain', slug: 'client-mtls/maintain' },
+          { label: 'Remove', slug: 'client-mtls/remove' },
+        ],
+      },
+      {
+        label: 'Wingman',
+        collapsed: false,
+        items: [
+          { label: 'Overview', slug: 'wingman' },
+          { label: 'Prerequisites', slug: 'wingman/prerequisites' },
+          { label: 'Configuration', slug: 'wingman/configuration' },
+          { label: 'Configure', slug: 'wingman/configure' },
+          { label: 'Verify', slug: 'wingman/verify' },
+          { label: 'Maintain', slug: 'wingman/maintain' },
+          { label: 'Remove', slug: 'wingman/remove' },
+          { label: 'Infrastructure', slug: 'wingman/validation' },
+        ],
+      },
+    ],
+  },
+
   statistics: {
     locales: { en: { label: 'English', lang: 'en' } },
     defaultLocale: 'en',