(maint) Adjust highlights

This commit aims to make highlights a little easier to work with. Namely: - Adjust the highlights to have consistent front matter. - Remove old sidebar entries that are no longer there. - Update ReadMe with some guidance about adding highlights to the front page or sidebar - Add a highlight for the Chocolatey CLI releases from December 4th.
chocolatey · Dec 6, 2024 · 40fd8c0 · 40fd8c0
1 parent 1b7543a
commit 40fd8c0
Show file tree

Hide file tree

Showing 26 changed files with 102 additions and 127 deletions.
diff --git a/README.md b/README.md
@@ -122,18 +122,35 @@ A Highlight is what is shown on the home page of docs.chocolatey.org and the lef
 
 ### Front Page Highlight
 
+For front page highlights, we should try to keep it to less than 6 highlights. When adding a new one, consider editting existing highlights to set `showOnHome` to `false`.
+
 1. Navigate to `src/content/docs/en-us/highlights` then into the current year folder.
-1. Copy a file that does not have a `-sidebar` in the file name.
+1. Copy an existing file.
 1. Change the name of the new file to include the month number as the first characters in the name, such as `10-testing-home.md`.
 1. Fill in details needed and follow the current naming convention for xrefs in the file.
     1. Change the `ctaText` value to something unique.
 
 ### Left Sidebar Highlight
 
-1. Navigate to `src/content/docs/en-us/highlights` then into the current year folder.
-1. Copy a file that has a `-sidebar` in the file name.
-1. Change the name of the new file to include the month number as the first characters in the name, such as `10-testing-home-sidebar.md`. Ensure the `-sidebar` in the name is retained.
-1. In the nested `highlight` front matter, ensure the following are set:
+For left sidebar highlights, we want to keep it to a minimum to reduce the amount the navigation is pushed down the page. It's recommended to edit only the top highlight file to link to the current highlighted article, and leave the bottom one to link to all highlights.
+
+To edit either of these highlights:
+
+1. Navigate to `src/content/docs/en-us/highlights`.
+1. Find the highlight you want to edit: `00-top-sidebar-highlight.md` for the top one, and `99-bottom-sidebar-highlight.md` for the bottom one.
+1. Edit the details as desired making note of the following `highlight` front matter settings that control the destination and link text:
+    ```markdown
+    ctaXref: highlights
+    ctaAnchor: december-2024
+    ctaText: View December's highlights
+    ```
+
+If it's decided that extra highlights should be added:
+
+1. Navigate to `src/content/docs/en-us/highlights`.
+1. Copy one of the existing `*sidebar-highlight.md` files.
+1. Change the name of the new file to start with a number that will determine it's order in the sidebar, such as `10-testing-home-sidebar-highlight.md`. Ensure the `-sidebar-highlight` in the name is retained.
+1. In the nested `highlight` front matter, ensure the following are set in the nested `highlight` front matter:
     ```markdown
     showOnHome: false
     showOnHighlights: false

diff --git a/src/content/docs/en-us/highlights/00-top-sidebar-highlight.md b/src/content/docs/en-us/highlights/00-top-sidebar-highlight.md
@@ -0,0 +1,14 @@
+---
+order: 0
+xref: highlight-sidebar-top-highlights
+title: Chocolatey product releases
+description: We recently released new versions of Chocolatey CLI, Chocolatey Licensed Extension, and Chocolatey Agent.
+highlight:
+  postedDateTime: 2024-11-12T00:00:00Z
+  ctaXref: highlights
+  ctaAnchor: december-2024
+  ctaText: View December's highlights
+  showOnHome: false
+  showOnHighlights: false
+  showInSidebar: true
+---
diff --git a/src/content/docs/en-us/highlights/2023/05-choco-new-in-v2.md b/src/content/docs/en-us/highlights/2023/05-choco-new-in-v2.md
@@ -3,9 +3,10 @@ order: 0
 xref: highlight-2023-05-31-choco-new-in-v2
 title: What's new in Chocolatey CLI v2.0.0
 description: Learn all about what's new in Chocolatey CLI v2.0.0 including NuGet v3 feed support, SemVer 2.0.0 support, .NET Framework uplift, and many other fantastic updates!
-showInSidebar: false
 highlight:
   postedDateTime: 2023-05-31T03:00:00Z
   ctaXref: choco-new-in-v2
   ctaText: See what's new
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2023/05-choco-v2-release-notes.md b/src/content/docs/en-us/highlights/2023/05-choco-v2-release-notes.md
@@ -3,7 +3,6 @@ order: 0
 xref: highlight-2023-05-31-choco-release-notes
 title: Chocolatey CLI v2.0.0 Release Notes
 description: Discover the new improvements, essential bug fixes, and important breaking changes in Chocolatey CLI v2.0.0 by exploring the detailed release notes.
-showInSidebar: false
 highlight:
   postedDateTime: 2023-05-31T01:00:00Z
   ctaXref: choco-release-notes

diff --git a/src/content/docs/en-us/highlights/2023/05-choco-v2-upgrade-guide.md b/src/content/docs/en-us/highlights/2023/05-choco-v2-upgrade-guide.md
@@ -3,9 +3,10 @@ order: 0
 xref: highlight-2023-05-31-upgrading-to-chocolatey-v2-v6
 title: "Upgrade Guide: Chocolatey Products v2.0.0 and Chocolatey Licensed Extension 6.0.0"
 description: Ensure a smooth transition to the powerful Chocolatey CLI v2.0.0 by following our comprehensive upgrade guide, equipped with step-by-step instructions and helpful tips.
-showInSidebar: false
 highlight:
   postedDateTime: 2023-05-31T02:00:00Z
   ctaXref: upgrading-to-chocolatey-v2-v6
   ctaText: Step through the guide
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2023/07-choco-troubleshooting-dependencies.md b/src/content/docs/en-us/highlights/2023/07-choco-troubleshooting-dependencies.md
@@ -3,9 +3,10 @@ order: 0
 xref: highlight-2023-07-14-choco-dependency-troubles
 title: Dependency Troubleshooting in Chocolatey CLI
 description: Discover how to troubleshoot and resolve installation and upgrade errors caused by dependency issues. Learn step-by-step instructions on resolving package failures and ensuring a consistent state by running the appropriate commands.
-showInSidebar: false
 highlight:
   postedDateTime: 2023-07-14T03:00:00Z
   ctaXref: choco-dependency-troubles
   ctaText: Get dependency troubleshooting help
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/.../en-us/highlights/2023/07-choco-troubleshooting-unable-to-load-service-index.md b/.../en-us/highlights/2023/07-choco-troubleshooting-unable-to-load-service-index.md
@@ -3,9 +3,10 @@ order: 0
 xref: highlight-2023-07-13-choco-unable-to-load-service-index
 title: Resolving Chocolatey CLI Package Source Communication Issues
 description: Diagnose and resolve communication issues with Chocolatey CLI package sources, including SSL/TLS and certificate errors, and find solutions to ensure seamless package management.
-showInSidebar: false
 highlight:
   postedDateTime: 2023-07-13T03:00:00Z
   ctaXref: choco-unable-to-load-service-index
   ctaText: Fix package source issues
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2023/07-proxy-considerations-and-limitations.md b/src/content/docs/en-us/highlights/2023/07-proxy-considerations-and-limitations.md
@@ -3,9 +3,10 @@ order: 0
 xref: highlight-2023-07-14-proxy-settings
 title: "Proxy Configuration in Chocolatey: Precedence and Known Limitations"
 description: Explore the priority order for configuring proxies in Chocolatey and learn about known limitations affecting certain Chocolatey products' proxy settings.
-showInSidebar: false
 highlight:
   postedDateTime: 2023-07-14T04:00:00Z
   ctaXref: proxy-settings
   ctaText: Learn about proxies
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2023/09-chocolatey-central-management-0.11.0.md b/src/content/docs/en-us/highlights/2023/09-chocolatey-central-management-0.11.0.md
@@ -3,7 +3,6 @@ order: 0
 xref: highlight-2023-09-19-ccm-release-notes
 title: What's new in Chocolatey Central Management v0.11.0
 description: Learn all about what's new in Chocolatey Central Management v0.11.0, including import/export for Deployment Plans, exporting packages.config files, new retention policies, and improved email notifications for deployments!
-showInSidebar: false
 highlight:
   postedDateTime: 2023-09-19T00:00:00Z
   ctaXref: ccm-release-notes

diff --git a/...t/docs/en-us/highlights/2023/11-chocolatey-central-management-0.12.0-sidebar.md b/...t/docs/en-us/highlights/2023/11-chocolatey-central-management-0.12.0-sidebar.md
diff --git a/src/content/docs/en-us/highlights/2023/11-chocolatey-central-management-0.12.0.md b/src/content/docs/en-us/highlights/2023/11-chocolatey-central-management-0.12.0.md
@@ -3,10 +3,11 @@ order: 0
 xref: highlight-2023-11-29-ccm-release-notes
 title: What's new in Chocolatey Central Management v0.12.0
 description: Learn all about what's new in Chocolatey Central Management v0.12.0, including the ability to generate Deployment Plans from various different contexts, for example, from a Group, a Computer, or a piece of Software.
-showInSidebar: false
 highlight:
   postedDateTime: 2023-11-29T00:00:00Z
   ctaXref: ccm-release-notes
   ctaAnchor: november-29-2023
   ctaText: Read the release notes
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2024/06-new-in-choco-v2.3.0-sidebar.md b/src/content/docs/en-us/highlights/2024/06-new-in-choco-v2.3.0-sidebar.md
diff --git a/src/content/docs/en-us/highlights/2024/06-new-in-choco-v2.3.0.md b/src/content/docs/en-us/highlights/2024/06-new-in-choco-v2.3.0.md
@@ -3,10 +3,11 @@ order: 0
 xref: highlight-2024-06-05-choco-new-in-v2-3-0
 title: What's new in Chocolatey CLI v2.3.0
 description: Learn all about what's new in Chocolatey CLI v2.3.0, including new features like the ability to save software installation location for later use, as well as many new improvements including enhanced exit codes for numerous Chocolatey CLI commands.
-showInSidebar: false
 highlight:
   postedDateTime: 2024-06-05T00:00:00Z
   ctaXref: choco-release-notes
   ctaAnchor: v2.3.0
   ctaText: Read the release notes
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/...t/docs/en-us/highlights/2024/07-chocolatey-central-management-0.13.0-sidebar.md b/...t/docs/en-us/highlights/2024/07-chocolatey-central-management-0.13.0-sidebar.md
diff --git a/src/content/docs/en-us/highlights/2024/07-chocolatey-central-management-0.13.0.md b/src/content/docs/en-us/highlights/2024/07-chocolatey-central-management-0.13.0.md
@@ -1,12 +1,13 @@
 ---
 order: 0
 xref: highlight-2024-09-19-ccm-new-in-v0-13-0
-title: What's new in Chocolatey Central Management
+title: What's new in Chocolatey Central Management v0.13.0
 description: Learn all about what's new in Chocolatey Central Management v0.13.0, including an uplift of the framework to .NET 8.0.
-showInSidebar: false
 highlight:
   postedDateTime: 2024-09-19T00:00:00Z
   ctaXref: ccm-release-notes
   ctaAnchor: v0.13.0
   ctaText: Read the release notes
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2024/07-chocolatey-central-management-0.13.1.md b/src/content/docs/en-us/highlights/2024/07-chocolatey-central-management-0.13.1.md
@@ -1,12 +1,13 @@
 ---
 order: 0
 xref: highlight-2024-10-16-ccm-new-in-v0-13-1
-title: What's new in Chocolatey Central Management
+title: What's new in Chocolatey Central Management v0.13.1
 description: Learn all about what's new in Chocolatey Central Management v0.13.1.
-showInSidebar: false
 highlight:
   postedDateTime: 2024-10-16T00:00:00Z
   ctaXref: ccm-release-notes
   ctaAnchor: v0.13.1
   ctaText: Read the release notes
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/...t/docs/en-us/highlights/2024/08-chocolatey-central-management-0.13.1-sidebar.md b/...t/docs/en-us/highlights/2024/08-chocolatey-central-management-0.13.1-sidebar.md
diff --git a/src/content/docs/en-us/highlights/2024/09-chocolatey-cli-2.4.0-sidebar.md b/src/content/docs/en-us/highlights/2024/09-chocolatey-cli-2.4.0-sidebar.md
diff --git a/...ighlights/2024/09-chocolatey-cli-2.4.0.md → ...ighlights/2024/11-chocolatey-cli-2.4.0.md b/...ighlights/2024/09-chocolatey-cli-2.4.0.md → ...ighlights/2024/11-chocolatey-cli-2.4.0.md
@@ -3,10 +3,11 @@ order: 0
 xref: highlight-2024-11-12-choco-release-notes
 title: What's new in Chocolatey CLI v2.4.0
 description: Learn all about what's new in Chocolatey CLI v2.4.0.
-showInSidebar: false
 highlight:
   postedDateTime: 2024-11-12T00:00:00Z
   ctaXref: choco-release-notes
   ctaAnchor: v2.4.0
   ctaText: Read the release notes
+  showOnHome: false
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2024/12-chocolatey-agent-2.2.0-sidebar.md b/src/content/docs/en-us/highlights/2024/12-chocolatey-agent-2.2.0-sidebar.md
diff --git a/src/content/docs/en-us/highlights/2024/12-chocolatey-agent-2.2.0.md b/src/content/docs/en-us/highlights/2024/12-chocolatey-agent-2.2.0.md
@@ -3,10 +3,11 @@ order: 0
 xref: highlight-2024-12-04-agent-release-notes
 title: What's new in Chocolatey Agent v2.2.0
 description: Learn all about what's new in Chocolatey Agent v2.2.0.
-showInSidebar: false
 highlight:
   postedDateTime: 2024-12-04T00:00:00Z
   ctaXref: agent-release-notes
   ctaAnchor: v2.2.0
   ctaText: Read the release notes
+  showOnHome: true
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/2024/12-chocolatey-cli-1.4.1.md b/src/content/docs/en-us/highlights/2024/12-chocolatey-cli-1.4.1.md
@@ -0,0 +1,13 @@
+---
+order: 0
+xref: highlight-2024-12-04-chocolatey-cli-1.4.1
+title: What's new in Chocolatey CLI v1.4.1
+description: Learn all about what's new in Chocolatey CLI v1.4.1.
+highlight:
+  postedDateTime: 2024-12-04T00:00:20Z
+  ctaXref: choco-release-notes
+  ctaAnchor: v1.4.1
+  ctaText: Read the release notes
+  showOnHome: true
+  showOnHighlights: true
+---
diff --git a/src/content/docs/en-us/highlights/2024/12-chocolatey-cli-2.4.1.md b/src/content/docs/en-us/highlights/2024/12-chocolatey-cli-2.4.1.md
@@ -0,0 +1,13 @@
+---
+order: 0
+xref: highlight-2024-12-04-chocolatey-cli-2.4.1
+title: What's new in Chocolatey CLI v2.4.1
+description: Learn all about what's new in Chocolatey CLI v2.4.1.
+highlight:
+  postedDateTime: 2024-12-04T00:00:20Z
+  ctaXref: choco-release-notes
+  ctaAnchor: v2.4.1
+  ctaText: Read the release notes
+  showOnHome: true
+  showOnHighlights: true
+---
diff --git a/src/content/docs/en-us/highlights/2024/12-chocolatey-extension-6.3.0-sidebar.md b/src/content/docs/en-us/highlights/2024/12-chocolatey-extension-6.3.0-sidebar.md
diff --git a/src/content/docs/en-us/highlights/2024/12-chocolatey-extension-6.3.0.md b/src/content/docs/en-us/highlights/2024/12-chocolatey-extension-6.3.0.md
@@ -3,10 +3,11 @@ order: 0
 xref: highlight-2024-12-04-licensed-extension-release-notes
 title: What's new in Chocolatey Licensed Extension v6.3.0
 description: Learn all about what's new in Chocolatey Licensed Extension v6.3.0.
-showInSidebar: false
 highlight:
-  postedDateTime: 2024-12-04T00:00:00Z
+  postedDateTime: 2024-12-04T00:00:20Z
   ctaXref: choco-release-notes
   ctaAnchor: v6.3.0
   ctaText: Read the release notes
+  showOnHome: true
+  showOnHighlights: true
 ---
diff --git a/src/content/docs/en-us/highlights/99-bottom-sidebar-highlight.md b/src/content/docs/en-us/highlights/99-bottom-sidebar-highlight.md
@@ -0,0 +1,13 @@
+---
+order: 0
+xref: highlight-sidebar-recent-highlights
+title: Highlighted documentation
+description: What's been happening in documentation land.
+highlight:
+  postedDateTime: 2024-11-12T00:00:00Z
+  ctaXref: highlights
+  ctaText: See our documentation highlights
+  showOnHome: false
+  showOnHighlights: false
+  showInSidebar: true
+---