From 0b081246b01edc40c86fd16d5b8352d1b8422a53 Mon Sep 17 00:00:00 2001 From: Chris Farhood Date: Thu, 12 Feb 2026 11:19:05 -0500 Subject: [PATCH] docs: remove marketing fluff and emojis MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Remove navigation emojis from README and docs/README - Remove "Made with ❤️ for the Kubernetes community" footer - Remove checkmark/celebration emojis from quick-start guide - Remove "(This!)" annotation from architecture diagrams - Replace emoji references with plain text in features documentation - Remove GOOD/BAD emojis from production deployment guide - Simplify congratulations message Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude Co-Authored-By: Happy --- README.md | 7 ++----- docs/ARCHITECTURE.md | 2 +- docs/README.md | 10 +++++----- docs/architecture/overview.md | 2 +- docs/getting-started/quick-start.md | 10 ++++------ docs/user-guide/features.md | 4 ++-- 6 files changed, 15 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a1c2160..0efc2e7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A [Headlamp](https://headlamp.dev/) plugin that surfaces [Fairwinds Polaris](https://polaris.docs.fairwinds.com/) audit results directly in the Headlamp UI. -**📚 [Documentation](#documentation) | 🚀 [Installation](#installing) | 🔒 [Security](#rbac--security-setup) | 🛠️ [Development](#development)** +**[Documentation](#documentation) | [Installation](#installing) | [Security](#rbac--security-setup) | [Development](#development)** ## What It Does @@ -172,7 +172,7 @@ Every proxied request is recorded in Kubernetes API audit logs as a `get` on `se ## Documentation -📚 **[Complete Documentation](docs/README.md)** - Documentation hub with all guides +**[Complete Documentation](docs/README.md)** - Documentation hub with all guides ### Quick Links @@ -374,6 +374,3 @@ Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for: [Apache-2.0 License](LICENSE) - see LICENSE file for details. ---- - -**Made with ❤️ for the Kubernetes community** diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 9c3fd40..ef48ea5 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -43,7 +43,7 @@ The Headlamp Polaris Plugin is a **read-only dashboard** that surfaces Fairwinds │ └────────┬────────┘ │ │ │ │ │ ┌─────────────▼──────────────┐ │ -│ │ Polaris Plugin (This!) │ │ +│ │ Polaris Plugin │ │ │ ├────────────────────────────┤ │ │ │ • registerSidebarEntry │ │ │ │ • registerRoute │ │ diff --git a/docs/README.md b/docs/README.md index 75bddfb..e89d423 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,11 +4,11 @@ Central hub for Headlamp Polaris Plugin documentation. ## Quick Links -- 🚀 [Quick Start](getting-started/quick-start.md) -- 📖 [Installation Guide](getting-started/installation.md) -- 🔧 [Troubleshooting](troubleshooting/README.md) -- 🏗️ [Architecture](architecture/overview.md) -- 💻 [Development](development/workflow.md) +- [Quick Start](getting-started/quick-start.md) +- [Installation Guide](getting-started/installation.md) +- [Troubleshooting](troubleshooting/README.md) +- [Architecture](architecture/overview.md) +- [Development](development/workflow.md) ## Getting Started diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md index a2175ea..34a636c 100644 --- a/docs/architecture/overview.md +++ b/docs/architecture/overview.md @@ -32,7 +32,7 @@ The Headlamp Polaris Plugin is a **read-only dashboard** that surfaces Fairwinds │ └────────┬────────┘ │ │ │ │ │ ┌─────────────▼──────────────┐ │ -│ │ Polaris Plugin (This!) │ │ +│ │ Polaris Plugin │ │ │ ├────────────────────────────┤ │ │ │ • registerSidebarEntry │ │ │ │ • registerRoute │ │ diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index e20dadf..4cc2db0 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -6,9 +6,9 @@ Get the Headlamp Polaris Plugin up and running in 5 minutes. Before starting, ensure: -- ✅ Kubernetes cluster is running -- ✅ Headlamp v0.26+ is deployed -- ✅ Polaris is installed with dashboard enabled +- Kubernetes cluster is running +- Headlamp v0.26+ is deployed +- Polaris is installed with dashboard enabled Don't have these? See [Prerequisites](prerequisites.md) for installation instructions. @@ -276,6 +276,4 @@ If test fails, see [Troubleshooting](../troubleshooting/README.md). --- -**Congratulations!** You're now running the Headlamp Polaris Plugin. 🎉 - -Visit the **Polaris** section in Headlamp to explore your cluster's security, reliability, and efficiency audit results. +You're now running the Headlamp Polaris Plugin. Visit the **Polaris** section in Headlamp to explore your cluster's security, reliability, and efficiency audit results. diff --git a/docs/user-guide/features.md b/docs/user-guide/features.md index a381c26..a818578 100644 --- a/docs/user-guide/features.md +++ b/docs/user-guide/features.md @@ -117,13 +117,13 @@ Top-right corner of Headlamp shows a persistent cluster score badge. **Features:** - **Color-Coded Chip** - Green/Yellow/Red based on score -- **Shield Emoji (🛡️)** - Visual indicator +- **Shield Icon** - Visual indicator - **Score Percentage** - e.g., "85%" - **Clickable** - Click to navigate to Polaris overview - **Real-Time Updates** - Updates on auto-refresh interval - **Always Visible** - Appears on all Headlamp pages -**Example:** `🛡️ 85%` (green chip) +**Example:** Shield icon with "85%" (green chip) ## Settings & Configuration