@f5-sales-demo/docs-theme 4.6.1 → 4.7.1

package/README.md

@@ -33,3 +33,13 @@ branch naming, and CI requirements.
 ## License
 
 See [LICENSE](LICENSE).
+
+## Canadian flag artwork
+
+`assets/canada-flag.svg` is the unmodified Canadian 4:3 flag from
+[flag-icons v7.5.0](https://github.com/lipis/flag-icons/tree/v7.5.0).
+`assets/canada-favicon.svg` centers the same flag on a square white canvas.
+Copyright and MIT license terms are retained in
+[assets/flag-icons-LICENSE.txt](assets/flag-icons-LICENSE.txt).
+The Canada publication profile preserves English routing and selects its local flag favicon.
+Callers can override the optional `favicon` field in `createF5xcDocsConfig`.

package/assets/canada-favicon.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><rect width="640" height="640" fill="#fff"/><g transform="translate(0 80)">
+  <path fill="#fff" d="M150.1 0h339.7v480H150z"/>
+  <path fill="#d52b1e" d="M-19.7 0h169.8v480H-19.7zm509.5 0h169.8v480H489.9zM201 232l-13.3 4.4 61.4 54c4.7 13.7-1.6 17.8-5.6 25l66.6-8.4-1.6 67 13.9-.3-3.1-66.6 66.7 8c-4.1-8.7-7.8-13.3-4-27.2l61.3-51-10.7-4c-8.8-6.8 3.8-32.6 5.6-48.9 0 0-35.7 12.3-38 5.8l-9.2-17.5-32.6 35.8c-3.5.9-5-.5-5.9-3.5l15-74.8-23.8 13.4q-3.2 1.3-5.2-2.2l-23-46-23.6 47.8q-2.8 2.5-5 .7L264 130.8l13.7 74.1c-1.1 3-3.7 3.8-6.7 2.2l-31.2-35.3c-4 6.5-6.8 17.1-12.2 19.5s-23.5-4.5-35.6-7c4.2 14.8 17 39.6 9 47.7"/>
+</g></svg>

package/assets/canada-flag.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="flag-icons-ca" viewBox="0 0 640 480">
+  <path fill="#fff" d="M150.1 0h339.7v480H150z"/>
+  <path fill="#d52b1e" d="M-19.7 0h169.8v480H-19.7zm509.5 0h169.8v480H489.9zM201 232l-13.3 4.4 61.4 54c4.7 13.7-1.6 17.8-5.6 25l66.6-8.4-1.6 67 13.9-.3-3.1-66.6 66.7 8c-4.1-8.7-7.8-13.3-4-27.2l61.3-51-10.7-4c-8.8-6.8 3.8-32.6 5.6-48.9 0 0-35.7 12.3-38 5.8l-9.2-17.5-32.6 35.8c-3.5.9-5-.5-5.9-3.5l15-74.8-23.8 13.4q-3.2 1.3-5.2-2.2l-23-46-23.6 47.8q-2.8 2.5-5 .7L264 130.8l13.7 74.1c-1.1 3-3.7 3.8-6.7 2.2l-31.2-35.3c-4 6.5-6.8 17.1-12.2 19.5s-23.5-4.5-35.6-7c4.2 14.8 17 39.6 9 47.7"/>
+</svg>

package/assets/flag-icons-LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Panayiotis Lipiridis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/config.ts

@@ -4,7 +4,7 @@ import { unified } from '@astrojs/markdown-remark';
 import react from '@astrojs/react';
 import starlight from '@astrojs/starlight';
 import type { StarlightPlugin } from '@astrojs/starlight/types';
-import { BCP47_TO_SLUG, SLUG_LIST } from '@f5-sales-demo/i18n-core';
+import { BCP47_TO_SLUG } from '@f5-sales-demo/i18n-core';
 import starlightLlmsTxt from '@f5-sales-demo/starlight-llms-txt';
 import type { MegaMenuItem } from '@f5-sales-demo/starlight-mega-menu';
 import starlightMegaMenu from '@f5-sales-demo/starlight-mega-menu';
@@ -35,6 +35,7 @@ import canonicalLlms from './src/utils/canonical-llms.mjs';
 import { providerMegaMenu } from './src/utils/canonical-provider.ts';
 import { menuLocalizationPolicy } from './src/utils/menu-localization.ts';
 import { stagedProviderSections } from './src/utils/provider-sections.ts';
+import { repositoryPublicationProfile } from './src/utils/publication-profiles.ts';
 import { resolveMegaMenuIcon } from './src/utils/resolve-icon.ts';
 import providerSharedAssets from './src/utils/share-provider-assets.mjs';
 import { buildSubcategorySidebar } from './src/utils/subcategory-sidebar.ts';
@@ -116,6 +117,7 @@ export interface F5xcDocsConfigOptions {
   additionalRemarkPlugins?: Array<unknown>;
   megaMenuItems?: MegaMenuItem[];
   head?: HeadEntry[];
+  favicon?: string;
   logo?: { src: string } | { light: string; dark: string };
   federatedSearch?: boolean;
   locales?: Record<string, { label: string; lang: string; dir?: 'rtl' }> | false;
@@ -252,6 +254,19 @@ export const defaultMegaMenuItems: MegaMenuItem[] = [
               href: 'https://f5-sales-demo.github.io/multi-cloud-networking/',
               icon: resolveMegaMenuIcon('f5xc:multi-cloud-network-connect'),
             },
+            {
+              label: 'Canada Topology',
+              description: 'Canadian hosting and regional access control',
+              href: 'https://f5-sales-demo.github.io/canada/',
+              icon: {
+                body: fs
+                  .readFileSync(new URL('./assets/canada-flag.svg', import.meta.url), 'utf8')
+                  .replace(/<svg[^>]*>|<\/svg>/g, ''),
+                width: 640,
+                height: 480,
+                mode: 'original',
+              },
+            },
             {
               label: 'Content Delivery',
               translations: itemLabels['Content Delivery'],
@@ -639,6 +654,7 @@ export const federatedSearchSites = [
   { repo: 'observability', label: 'Observability' },
   { repo: 'was', label: 'Web App Scanning' },
   { repo: 'multi-cloud-networking', label: 'Multi-Cloud Networking' },
+  { repo: 'canada', label: 'Canada Topology' },
   { repo: 'dns', label: 'DNS' },
   { repo: 'cdn', label: 'CDN' },
   { repo: 'bot-standard', label: 'Bot Standard' },
@@ -681,6 +697,8 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
   const title = options.title || process.env.DOCS_TITLE || (canonicalProvider ? 'Terraform Provider' : 'Documentation');
   const description = options.description || process.env.DOCS_DESCRIPTION || '';
   const githubRepository = options.githubRepository || process.env.GITHUB_REPOSITORY || '';
+  const publicationProfile = repositoryPublicationProfile(githubRepository);
+  const favicon = options.favicon || publicationProfile?.favicon;
   let llmsOptionalLinks: Array<{ title: string; url: string }> = options.llmsOptionalLinks || [];
   if (!options.llmsOptionalLinks && process.env.LLMS_OPTIONAL_LINKS) {
     try {
@@ -815,6 +833,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
             tieredHierarchy: true,
             promote: llmsConfig.promote || ['index*', 'overview*'],
             demote: llmsConfig.demote || ['references*'],
+            ...(llmsConfig.exclude ? { exclude: llmsConfig.exclude } : {}),
             ...(llmsFederatedSites.length > 0 ? { federatedSites: llmsFederatedSites } : {}),
             ...(llmsFederatedSiteCategories.length > 0 ? { federatedSiteCategories: llmsFederatedSiteCategories } : {}),
             ...(progressiveCorpus ? { progressiveCorpus } : {}),
@@ -832,13 +851,13 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
   const resolvedLocales =
     canonicalProvider || options.locales === false
       ? undefined
-      : options.locales || (hasEnSubdir ? f5xcDefaultLocales : undefined);
-  const resolvedDefaultLocale = options.defaultLocale || f5xcDefaultLocale;
+      : options.locales || publicationProfile?.locales || (hasEnSubdir ? f5xcDefaultLocales : undefined);
+  const resolvedDefaultLocale = options.defaultLocale || publicationProfile?.defaultLocale || f5xcDefaultLocale;
 
   const localeHeadScripts: HeadEntry[] = [];
   if (resolvedLocales) {
     const langToSlugMap = BCP47_TO_SLUG;
-    const slugSet = JSON.stringify(SLUG_LIST);
+    const slugSet = JSON.stringify(Object.keys(resolvedLocales));
 
     localeHeadScripts.push({
       tag: 'script',
@@ -905,6 +924,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
         head: [...((head as Parameters<typeof starlight>[0]['head']) || []), ...localeHeadScripts] as Parameters<
           typeof starlight
         >[0]['head'],
+        ...(favicon ? { favicon } : {}),
         logo: logo as Parameters<typeof starlight>[0]['logo'],
         ...(resolvedLocales ? { locales: resolvedLocales, defaultLocale: resolvedDefaultLocale } : {}),
         ...(subcategorySidebar

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.6.1",
+  "version": "4.7.1",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {
@@ -44,7 +44,9 @@
     "./canonical-route-middleware": "./canonical-route-middleware.ts",
     "./components/ProviderSidebar.astro": "./components/ProviderSidebar.astro",
     "./components/ProviderHeader.astro": "./components/ProviderHeader.astro",
-    "./components/SharedHeader.astro": "./components/SharedHeader.astro"
+    "./components/SharedHeader.astro": "./components/SharedHeader.astro",
+    "./assets/canada-flag.svg": "./assets/canada-flag.svg",
+    "./assets/canada-favicon.svg": "./assets/canada-favicon.svg"
   },
   "files": [
     "index.ts",

package/src/utils/localize-ecosystem-href.ts

@@ -1,4 +1,5 @@
 import { bcp47ToSlug, VALID_SLUGS } from '@f5-sales-demo/i18n-core';
+import { publicationProfiles } from './publication-profiles';
 
 const ECOSYSTEM_HOST = 'f5-sales-demo.github.io';
 
@@ -34,7 +35,8 @@ export function localizeEcosystemHref(
     return href;
   }
 
-  segments.splice(1, 0, localeSlug);
+  const profile = publicationProfiles[segments[0]];
+  segments.splice(1, 0, profile ? profile.defaultLocale : localeSlug);
   url.pathname = `/${segments.join('/')}/`;
 
   return url.toString();

package/src/utils/publication-profiles.test.ts

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest';
+import { localizeEcosystemHref } from './localize-ecosystem-href';
+import { repositoryPublicationProfile } from './publication-profiles';
+
+describe('Canadian publication', () => {
+  it('publishes only English and selects the flag favicon', () => {
+    expect(repositoryPublicationProfile('f5-sales-demo/canada')).toEqual({
+      locales: { en: { label: 'English', lang: 'en' } },
+      defaultLocale: 'en',
+      favicon: '/assets/canada-favicon.svg',
+    });
+    expect(repositoryPublicationProfile('f5-sales-demo/multi-cloud-networking')).toBeUndefined();
+  });
+  it('routes foreign-language ecosystem visitors to available English content', () => {
+    expect(localizeEcosystemHref('https://f5-sales-demo.github.io/canada/', 'fr')).toBe(
+      'https://f5-sales-demo.github.io/canada/en/',
+    );
+  });
+});

package/src/utils/publication-profiles.ts

@@ -0,0 +1,15 @@
+/** Repository publication decisions shared by navigation and site configuration. */
+export const publicationProfiles: Record<
+  string,
+  { locales: Record<string, { label: string; lang: string }>; defaultLocale: string; favicon: string }
+> = {
+  canada: {
+    locales: { en: { label: 'English', lang: 'en' } },
+    defaultLocale: 'en',
+    favicon: '/assets/canada-favicon.svg',
+  },
+};
+
+export function repositoryPublicationProfile(repository: string) {
+  return publicationProfiles[repository.split('/').pop() || ''];
+}