From 5d49fc27fb02b06c642b3684d193e7934d4d5917 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Sun, 16 Nov 2025 19:45:35 +0100 Subject: [PATCH 1/9] site: add links to configuration file Introduces _navbarLinks and _asfLinks configuration in docfx.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it. --- websites/site/docfx.json | 59 ++++++++++++++++++- .../partials/navbar-links.tmpl.partial | 17 ++++++ .../partials/navbar.tmpl.partial | 1 + 3 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 websites/site/lucenetemplate/partials/navbar-links.tmpl.partial diff --git a/websites/site/docfx.json b/websites/site/docfx.json index 47a525640d..84f415b70f 100644 --- a/websites/site/docfx.json +++ b/websites/site/docfx.json @@ -45,7 +45,64 @@ "_gitContribute": { "repo": "https://github.com/apache/lucenenet", "branch": "master" - } + }, + "_navbarLinks": [ + { + "text": "About", + "href": "/#about", + "title": "About" + }, + { + "text": "Quick Start", + "href": "/quick-start/index.html", + "title": "Quick Start" + }, + { + "text": "Download", + "href": "/download/download.html", + "title": "Download" + }, + { + "text": "Documentation", + "href": "/docs.html", + "title": "Documentation" + }, + { + "text": "Contributing", + "href": "/contributing/index.html", + "title": "Contributing" + } + ], + "_asfLinks": [ + { + "text": "Foundation", + "href": "https://www.apache.org/" + }, + { + "text": "Events", + "href": "https://events.apache.org/" + }, + { + "text": "License", + "href": "https://www.apache.org/licenses/" + }, + { + "text": "Thanks", + "href": "https://www.apache.org/foundation/thanks.html" + }, + { + "text": "Security", + "href": "https://www.apache.org/security/" + }, + { + "text": "Sponsorship", + "href": "https://www.apache.org/foundation/sponsorship.html" + }, + { + "text": "Privacy Policy", + "href": "https://privacy.apache.org/policies/privacy-policy-public.html" + } + ] }, "dest": "_site", "globalMetadataFiles": [], diff --git a/websites/site/lucenetemplate/partials/navbar-links.tmpl.partial b/websites/site/lucenetemplate/partials/navbar-links.tmpl.partial new file mode 100644 index 0000000000..3f7b8e2f6f --- /dev/null +++ b/websites/site/lucenetemplate/partials/navbar-links.tmpl.partial @@ -0,0 +1,17 @@ +{{! lucenetemplate/partials/navbar-links.tmpl.partial }} + + diff --git a/websites/site/lucenetemplate/partials/navbar.tmpl.partial b/websites/site/lucenetemplate/partials/navbar.tmpl.partial index ab8f5195d8..4f733b287f 100644 --- a/websites/site/lucenetemplate/partials/navbar.tmpl.partial +++ b/websites/site/lucenetemplate/partials/navbar.tmpl.partial @@ -17,6 +17,7 @@ + {{>partials/navbar-links}} From 27ea67d9baf57e0ee6b9ab38d88bad3ed2c586b1 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Tue, 18 Nov 2025 04:10:45 +0100 Subject: [PATCH 2/9] Fix breadcrumb styles in main.css Now the Api / Libraries works as intended, not splitting into two lines and the slash is restored. --- .../LuceneTemplateAssets/styles/main.css | 50 ++++++++++++------- 1 file changed, 33 insertions(+), 17 deletions(-) diff --git a/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css b/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css index b420cbfe95..f93014bd21 100644 --- a/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css +++ b/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css @@ -522,23 +522,6 @@ header.is-sticky nav.navbar { display: inline-block; } -/* 5.1 Breadcrumb padding adjustments */ -.subnav.navbar #breadcrumb { - padding-left: 28px; -} - -@media (min-width:1200px) { - .subnav.navbar #breadcrumb { - padding-left: 34px; - } -} - -@media (min-width:1600px) { - .subnav.navbar #breadcrumb { - padding-left: 40px; - } -} - /* 6. First-content padding / margin-collapse prevention ---------------------------------------------------- */ .container.body-content, @@ -802,3 +785,36 @@ button:focus-visible { margin-top: 50px !important; } } + +/* 9.4.1 Keep the inner (level1) trail inline and tidy */ +.subnav.navbar #breadcrumb .breadcrumb { + display: inline-flex; + align-items: baseline; + flex-wrap: wrap; + gap: .35rem; + margin: 0; + padding: 0; +} + +/* 9.4.2 Add the slash after “API/CLI” only when a trail exists */ +.subnav.navbar ul.level0.breadcrumb > li > a::after { + content: ""; +} +/* reset */ +.subnav.navbar ul.level0.breadcrumb > li:has(#breadcrumb .breadcrumb) > a::after { + content: " /"; + margin: 0 .35rem; + color: #bbb; +} + +/* 9.4.3 restore the default side padding for the breadcrumb container */ +.subnav.navbar .container { + padding: 8px 28px !important; /* 8 top/bottom, 15 left/right */ +} + +/* 9.4.4 mobile: add a little extra left indent (28px total feel) */ +@media (max-width: 767px) { + .subnav.navbar .container { + padding-left: 28px !important; /* right stays 15px */ + } +} From 7df016f307c9ad0f34143c10195ba8402c7e5562 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Tue, 9 Dec 2025 15:13:42 +0100 Subject: [PATCH 3/9] apidocs: add links to configuration file Introduces _navbarLinks and _asfLinks configuration in docfx.global.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it. --- .../partials/navbar-links.tmpl.partial | 17 +++++++ .../partials/navbar.tmpl.partial | 1 + websites/apidocs/docfx.global.json | 51 ++++++++++++++++++- websites/apidocs/toc.yml | 5 +- 4 files changed, 70 insertions(+), 4 deletions(-) create mode 100644 websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial diff --git a/websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial b/websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial new file mode 100644 index 0000000000..ada0839b48 --- /dev/null +++ b/websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial @@ -0,0 +1,17 @@ +{{! lucenetemplate/partials/navbar-links.tmpl.partial }} + + diff --git a/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial b/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial index 40a4a5188e..cb00ccba69 100644 --- a/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial +++ b/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial @@ -32,6 +32,7 @@ + {{>partials/navbar-links}} diff --git a/websites/apidocs/docfx.global.json b/websites/apidocs/docfx.global.json index 534ebd340b..03736bb9bb 100644 --- a/websites/apidocs/docfx.global.json +++ b/websites/apidocs/docfx.global.json @@ -1,4 +1,4 @@ -{ +{ "_appTitle": "Apache Lucene.NET 4.8.0-ci Documentation", "_disableContribution": true, "_appFaviconPath": "logo/favicon.ico", @@ -6,5 +6,52 @@ "_appLogoPath": "logo/lucene-net-color.png", "_appFooter": "Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.", "_gitSource": "https://github.com/apache/lucenenet.git", - "_luceneNetRel": "http://localhost:8080/" + "_luceneNetRel": "http://localhost:8080/", + "_navbarLinks": [ + { + "href": "https://lucenenet.apache.org/docs/4.8.0-ci/", + "title": "Lucene.Net API", + "text": "API" + }, + { + "href": "../../src/dotnet/tools/lucene-cli/docs/index.md", + "title": "Lucene.Net CLI", + "text": "CLI" + }, + { + "href": "https://lucenenet.apache.org/", + "title": "Lucene.Net Website", + "text": "Website" + } + ], + "_asfLinks": [ + { + "text": "Foundation", + "href": "https://www.apache.org/" + }, + { + "text": "Events", + "href": "https://events.apache.org/" + }, + { + "text": "License", + "href": "https://www.apache.org/licenses/" + }, + { + "text": "Thanks", + "href": "https://www.apache.org/foundation/thanks.html" + }, + { + "text": "Security", + "href": "https://www.apache.org/security/" + }, + { + "text": "Sponsorship", + "href": "https://www.apache.org/foundation/sponsorship.html" + }, + { + "text": "Privacy Policy", + "href": "https://privacy.apache.org/policies/privacy-policy-public.html" + } + ] } diff --git a/websites/apidocs/toc.yml b/websites/apidocs/toc.yml index 69fd8682fb..ad9da3bc87 100644 --- a/websites/apidocs/toc.yml +++ b/websites/apidocs/toc.yml @@ -1,4 +1,4 @@ -items: +items: - name: Lucene.Net API topicHref: https://lucenenet.apache.org/docs/4.8.0-ci/ - name: Lucene.Net CLI @@ -11,7 +11,7 @@ - name: Foundation href: https://www.apache.org/ - name: Events - href: https://www.apache.org/events/ + href: https://events.apache.org/ - name: License href: https://www.apache.org/licenses/ - name: Thanks @@ -22,3 +22,4 @@ href: https://www.apache.org/foundation/sponsorship.html - name: Privacy Policy href: https://privacy.apache.org/policies/privacy-policy-public.html + From b2be3d760459803f4813993b1ae52597a7c83011 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Fri, 19 Dec 2025 15:05:35 +0100 Subject: [PATCH 4/9] apidocs: move links to separate .json - Added docfx.links.json to organize navigation and ASF links separately. It now includes the links. - Modified docfx.site.json to include docfx.links.json in globalMetadataFiles. --- websites/apidocs/docfx.global.json | 49 +----------------------------- websites/apidocs/docfx.links.json | 49 ++++++++++++++++++++++++++++++ websites/apidocs/docfx.site.json | 3 +- 3 files changed, 52 insertions(+), 49 deletions(-) create mode 100644 websites/apidocs/docfx.links.json diff --git a/websites/apidocs/docfx.global.json b/websites/apidocs/docfx.global.json index 03736bb9bb..6911cdadb7 100644 --- a/websites/apidocs/docfx.global.json +++ b/websites/apidocs/docfx.global.json @@ -6,52 +6,5 @@ "_appLogoPath": "logo/lucene-net-color.png", "_appFooter": "Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.", "_gitSource": "https://github.com/apache/lucenenet.git", - "_luceneNetRel": "http://localhost:8080/", - "_navbarLinks": [ - { - "href": "https://lucenenet.apache.org/docs/4.8.0-ci/", - "title": "Lucene.Net API", - "text": "API" - }, - { - "href": "../../src/dotnet/tools/lucene-cli/docs/index.md", - "title": "Lucene.Net CLI", - "text": "CLI" - }, - { - "href": "https://lucenenet.apache.org/", - "title": "Lucene.Net Website", - "text": "Website" - } - ], - "_asfLinks": [ - { - "text": "Foundation", - "href": "https://www.apache.org/" - }, - { - "text": "Events", - "href": "https://events.apache.org/" - }, - { - "text": "License", - "href": "https://www.apache.org/licenses/" - }, - { - "text": "Thanks", - "href": "https://www.apache.org/foundation/thanks.html" - }, - { - "text": "Security", - "href": "https://www.apache.org/security/" - }, - { - "text": "Sponsorship", - "href": "https://www.apache.org/foundation/sponsorship.html" - }, - { - "text": "Privacy Policy", - "href": "https://privacy.apache.org/policies/privacy-policy-public.html" - } - ] + "_luceneNetRel": "http://localhost:8080/" } diff --git a/websites/apidocs/docfx.links.json b/websites/apidocs/docfx.links.json new file mode 100644 index 0000000000..dde14539c6 --- /dev/null +++ b/websites/apidocs/docfx.links.json @@ -0,0 +1,49 @@ +{ + "_navbarLinks": [ + { + "href": "https://lucenenet.apache.org/docs/4.8.0-beta00018/", + "title": "Lucene.Net API", + "text": "Lucene.Net API" + }, + { + "href": "../../src/dotnet/tools/lucene-cli/docs/index.md", + "title": "Lucene.Net CLI", + "text": "Lucene.Net CLI" + }, + { + "href": "https://lucenenet.apache.org/", + "title": "Lucene.Net Website", + "text": "Lucene.Net Website" + } + ], + "_asfLinks": [ + { + "text": "Foundation", + "href": "https://www.apache.org/" + }, + { + "text": "Events", + "href": "https://events.apache.org/" + }, + { + "text": "License", + "href": "https://www.apache.org/licenses/" + }, + { + "text": "Thanks", + "href": "https://www.apache.org/foundation/thanks.html" + }, + { + "text": "Security", + "href": "https://www.apache.org/security/" + }, + { + "text": "Sponsorship", + "href": "https://www.apache.org/foundation/sponsorship.html" + }, + { + "text": "Privacy Policy", + "href": "https://privacy.apache.org/policies/privacy-policy-public.html" + } + ] +} diff --git a/websites/apidocs/docfx.site.json b/websites/apidocs/docfx.site.json index aea6662448..175493d21b 100644 --- a/websites/apidocs/docfx.site.json +++ b/websites/apidocs/docfx.site.json @@ -57,7 +57,8 @@ ], "dest": "_site", "globalMetadataFiles": [ - "docfx.global.json" + "docfx.global.json", + "docfx.links.json" ], "template": [ "default", From 2191eed0c50ecb7d5aa1691c5cbb14d870632145 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Wed, 7 Jan 2026 13:28:42 +0100 Subject: [PATCH 5/9] Update doc links to use latest Lucene.Net version Added docfx.links.json to metadata and updated navbar links to point to the latest CI documentation. Enhanced docs.ps1 to automatically update both docfx.links.json with the current LuceneNetVersion during the build process, ensuring navigation and API links always reference the correct version. --- websites/apidocs/docfx.core.json | 5 +++-- websites/apidocs/docfx.links.json | 30 +++++++++++++++++++++++++----- websites/apidocs/docs.ps1 | 7 +++++-- 3 files changed, 33 insertions(+), 9 deletions(-) diff --git a/websites/apidocs/docfx.core.json b/websites/apidocs/docfx.core.json index 0aaea539e4..7f752f7f8a 100644 --- a/websites/apidocs/docfx.core.json +++ b/websites/apidocs/docfx.core.json @@ -1,4 +1,4 @@ -{ +{ "metadata": [ { "src": [ @@ -77,7 +77,8 @@ "dest": "_site/api/core", "globalMetadataFiles": [ "docfx.global.json", - "docfx.global.subsite.json" + "docfx.global.subsite.json", + "docfx.links.json" ], "template": [ "Templates/DefaultTemplateNoAssets", diff --git a/websites/apidocs/docfx.links.json b/websites/apidocs/docfx.links.json index dde14539c6..fed3fa48b2 100644 --- a/websites/apidocs/docfx.links.json +++ b/websites/apidocs/docfx.links.json @@ -1,10 +1,10 @@ { "_navbarLinks": [ - { - "href": "https://lucenenet.apache.org/docs/4.8.0-beta00018/", - "title": "Lucene.Net API", - "text": "Lucene.Net API" - }, + { + "href": "https://lucenenet.apache.org/docs/4.8.0-ci/", + "title": "Lucene.Net API", + "text": "Lucene.Net API" + }, { "href": "../../src/dotnet/tools/lucene-cli/docs/index.md", "title": "Lucene.Net CLI", @@ -47,3 +47,23 @@ } ] } + + + + + + + + + + + + + + + + + + + + diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1 index 80bbbddfa1..9a7fa4558c 100644 --- a/websites/apidocs/docs.ps1 +++ b/websites/apidocs/docs.ps1 @@ -1,4 +1,4 @@ -# ----------------------------------------------------------------------------------- +# ----------------------------------------------------------------------------------- # # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with @@ -61,6 +61,7 @@ $CliIndexPath = Join-Path -Path $RepoRoot -ChildPath "src\dotnet\tools\lucene-cl $TocPath1 = Join-Path -Path $ApiDocsFolder -ChildPath "toc.yml" $TocPath2 = Join-Path -Path $ApiDocsFolder -ChildPath "toc\toc.yml" $BreadcrumbPath = Join-Path -Path $ApiDocsFolder -ChildPath "docfx.global.subsite.json" +$LinksPath = Join-Path -Path $ApiDocsFolder -ChildPath "docfx.links.json" # Links are now generated by docfx, not injected via JS # install docfx tool Write-Host "Restoring docfx tool..." @@ -72,7 +73,6 @@ try { Set-Location $PreviousLocation } - # delete anything that already exists if ($Clean) { Write-Host "Cleaning..." @@ -184,6 +184,9 @@ if ($? -and $DisableBuild -eq $false) { # Note we don't update _rel because that is used for styles and js (Get-Content -Path $BreadcrumbPath -Raw) -Replace '(?<="_api":\s*?"https?\:\/\/lucenenet\.apache\.org\/docs\/)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $BreadcrumbPath + # Update navbar link(s) in docfx.links.json that point to https://lucenenet.apache.org/docs/ + (Get-Content -Path $LinksPath -Raw) -Replace '(?<="href"\s*:\s*"(?:https?\:\/\/)lucenenet\.apache\.org\/docs\/)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $LinksPath + foreach ($proj in $DocFxJsonMeta) { $projFile = Join-Path -Path $ApiDocsFolder $proj From 88d089e4960ca3b33d3067dd5cc69105fdbb50c5 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Sun, 11 Jan 2026 18:38:28 +0100 Subject: [PATCH 6/9] Fix build error by storing navbar links differently and links not appearing inside the apidocs. - Refactor navbar links to use individual properties and moved to the subsite.json. - docfx.links.json and navbar-links.tmpl.partial removed. - docs.ps1 restored as it was originally. - Removed the link json file reference from the metadata docfx.core.json. --- .../partials/navbar-links.tmpl.partial | 17 ----- .../partials/navbar.tmpl.partial | 21 +++++- websites/apidocs/docfx.core.json | 3 +- websites/apidocs/docfx.global.subsite.json | 35 +++++++++- websites/apidocs/docfx.links.json | 69 ------------------- websites/apidocs/docs.ps1 | 4 -- 6 files changed, 55 insertions(+), 94 deletions(-) delete mode 100644 websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial delete mode 100644 websites/apidocs/docfx.links.json diff --git a/websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial b/websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial deleted file mode 100644 index ada0839b48..0000000000 --- a/websites/apidocs/Templates/LuceneTemplate/partials/navbar-links.tmpl.partial +++ /dev/null @@ -1,17 +0,0 @@ -{{! lucenetemplate/partials/navbar-links.tmpl.partial }} - - diff --git a/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial b/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial index cb00ccba69..173b4db1ac 100644 --- a/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial +++ b/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial @@ -32,7 +32,26 @@ - {{>partials/navbar-links}} + diff --git a/websites/apidocs/docfx.core.json b/websites/apidocs/docfx.core.json index 7f752f7f8a..d60970440a 100644 --- a/websites/apidocs/docfx.core.json +++ b/websites/apidocs/docfx.core.json @@ -77,8 +77,7 @@ "dest": "_site/api/core", "globalMetadataFiles": [ "docfx.global.json", - "docfx.global.subsite.json", - "docfx.links.json" + "docfx.global.subsite.json" ], "template": [ "Templates/DefaultTemplateNoAssets", diff --git a/websites/apidocs/docfx.global.subsite.json b/websites/apidocs/docfx.global.subsite.json index 89299bfa08..2bc8e84b8a 100644 --- a/websites/apidocs/docfx.global.subsite.json +++ b/websites/apidocs/docfx.global.subsite.json @@ -1,4 +1,37 @@ -{ +{ "_api": "https://lucenenet.apache.org/docs/4.8.0-ci/" + "_navApiTitle": "Lucene.Net API", + "_navApiText": "Lucene.Net API", + + "_navCliHref": "../../src/dotnet/tools/lucene-cli/docs/index.md", + "_navCliTitle": "Lucene.Net CLI", + "_navCliText": "Lucene.Net CLI", + + "_navWebsiteHref": "https://lucenenet.apache.org/", + "_navWebsiteTitle": "Lucene.Net Website", + "_navWebsiteText": "Lucene.Net Website", + + "_asfFoundationHref": "https://www.apache.org/", + "_asfFoundationText": "Foundation", + + "_asfEventsHref": "https://events.apache.org/", + "_asfEventsText": "Events", + + "_asfLicenseHref": "https://www.apache.org/licenses/", + "_asfLicenseText": "License", + + "_asfThanksHref": "https://www.apache.org/foundation/thanks.html", + "_asfThanksText": "Thanks", + + "_asfSecurityHref": "https://www.apache.org/security/", + "_asfSecurityText": "Security", + + "_asfSponsorshipHref": "https://www.apache.org/foundation/sponsorship.html", + "_asfSponsorshipText": "Sponsorship", + + "_asfPrivacyHref": "https://privacy.apache.org/policies/privacy-policy-public.html", + "_asfPrivacyText": "Privacy Policy" } + + diff --git a/websites/apidocs/docfx.links.json b/websites/apidocs/docfx.links.json deleted file mode 100644 index fed3fa48b2..0000000000 --- a/websites/apidocs/docfx.links.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "_navbarLinks": [ - { - "href": "https://lucenenet.apache.org/docs/4.8.0-ci/", - "title": "Lucene.Net API", - "text": "Lucene.Net API" - }, - { - "href": "../../src/dotnet/tools/lucene-cli/docs/index.md", - "title": "Lucene.Net CLI", - "text": "Lucene.Net CLI" - }, - { - "href": "https://lucenenet.apache.org/", - "title": "Lucene.Net Website", - "text": "Lucene.Net Website" - } - ], - "_asfLinks": [ - { - "text": "Foundation", - "href": "https://www.apache.org/" - }, - { - "text": "Events", - "href": "https://events.apache.org/" - }, - { - "text": "License", - "href": "https://www.apache.org/licenses/" - }, - { - "text": "Thanks", - "href": "https://www.apache.org/foundation/thanks.html" - }, - { - "text": "Security", - "href": "https://www.apache.org/security/" - }, - { - "text": "Sponsorship", - "href": "https://www.apache.org/foundation/sponsorship.html" - }, - { - "text": "Privacy Policy", - "href": "https://privacy.apache.org/policies/privacy-policy-public.html" - } - ] -} - - - - - - - - - - - - - - - - - - - - diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1 index 9a7fa4558c..473cd67e0c 100644 --- a/websites/apidocs/docs.ps1 +++ b/websites/apidocs/docs.ps1 @@ -61,7 +61,6 @@ $CliIndexPath = Join-Path -Path $RepoRoot -ChildPath "src\dotnet\tools\lucene-cl $TocPath1 = Join-Path -Path $ApiDocsFolder -ChildPath "toc.yml" $TocPath2 = Join-Path -Path $ApiDocsFolder -ChildPath "toc\toc.yml" $BreadcrumbPath = Join-Path -Path $ApiDocsFolder -ChildPath "docfx.global.subsite.json" -$LinksPath = Join-Path -Path $ApiDocsFolder -ChildPath "docfx.links.json" # Links are now generated by docfx, not injected via JS # install docfx tool Write-Host "Restoring docfx tool..." @@ -184,9 +183,6 @@ if ($? -and $DisableBuild -eq $false) { # Note we don't update _rel because that is used for styles and js (Get-Content -Path $BreadcrumbPath -Raw) -Replace '(?<="_api":\s*?"https?\:\/\/lucenenet\.apache\.org\/docs\/)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $BreadcrumbPath - # Update navbar link(s) in docfx.links.json that point to https://lucenenet.apache.org/docs/ - (Get-Content -Path $LinksPath -Raw) -Replace '(?<="href"\s*:\s*"(?:https?\:\/\/)lucenenet\.apache\.org\/docs\/)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $LinksPath - foreach ($proj in $DocFxJsonMeta) { $projFile = Join-Path -Path $ApiDocsFolder $proj From bc237224777f2f480ea98968be1e70c5d1f5ecc4 Mon Sep 17 00:00:00 2001 From: zkatona <92223927+zka26@users.noreply.github.com> Date: Sun, 11 Jan 2026 21:53:31 +0100 Subject: [PATCH 7/9] Update CLI doc link with auto-update and minor changes. - Change _navCliHref to absolute URL for published CLI docs - Removed the links jsons globalMetadataFiles leftover and the subsite one was added instead. - Auto-update CLI doc version in docs.ps1 - Improve navbar template indentation for readability and removed a debug message from it. --- .../partials/navbar.tmpl.partial | 27 +++++++++---------- websites/apidocs/docfx.global.subsite.json | 4 +-- websites/apidocs/docfx.site.json | 2 +- websites/apidocs/docs.ps1 | 3 +++ 4 files changed, 19 insertions(+), 17 deletions(-) diff --git a/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial b/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial index 173b4db1ac..11541a1a31 100644 --- a/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial +++ b/websites/apidocs/Templates/LuceneTemplate/partials/navbar.tmpl.partial @@ -33,22 +33,21 @@ + + diff --git a/websites/apidocs/docfx.global.subsite.json b/websites/apidocs/docfx.global.subsite.json index 81d333dc30..58c6365cf7 100644 --- a/websites/apidocs/docfx.global.subsite.json +++ b/websites/apidocs/docfx.global.subsite.json @@ -32,6 +32,3 @@ "_asfPrivacyHref": "https://privacy.apache.org/policies/privacy-policy-public.html", "_asfPrivacyText": "Privacy Policy" } - - - diff --git a/websites/apidocs/toc.yml b/websites/apidocs/toc.yml index ad9da3bc87..0a8e990ed0 100644 --- a/websites/apidocs/toc.yml +++ b/websites/apidocs/toc.yml @@ -22,4 +22,3 @@ items: href: https://www.apache.org/foundation/sponsorship.html - name: Privacy Policy href: https://privacy.apache.org/policies/privacy-policy-public.html - diff --git a/websites/site/lucenetemplate/partials/navbar.tmpl.partial b/websites/site/lucenetemplate/partials/navbar.tmpl.partial index 3f6fe1797c..14e2e89bbd 100644 --- a/websites/site/lucenetemplate/partials/navbar.tmpl.partial +++ b/websites/site/lucenetemplate/partials/navbar.tmpl.partial @@ -27,7 +27,7 @@
  • - ASF + ASF