Archival Announcement (#3272)

### Add Archival Announcement

Please be advised that this repository is slated to be deprecated and
will be marked as archived and read-only. While all existing code will
remain accessible, we will no longer accept new pull requests or issues
after the archiving date and no new features or updates will be
developed.

Website banner:
<img width="1512" alt="image"
src="https://github.com/user-attachments/assets/4d16f983-1aa0-4147-a27d-634c5c23fa10"
/>

Author: jecr

README.md

@@ -26,6 +26,8 @@
   </a>
 </p>
 
+> **Archival Announcement:** Please be advised that this repository is slated to be deprecated and will be marked as archived and read-only. While all existing code will remain accessible, we will no longer accept new pull requests or issues after the archiving date and no new features or updates will be developed. If you have any questions or concerns, please reach out to clutch@lyft.com.
+
 <p align="center">
   <a href="#key-features">Key Features</a> •
   <a href="#getting-started">Getting Started</a> •

docs/_website/docusaurus.config.js

@@ -13,6 +13,12 @@ module.exports = {
   plugins: [],
   customFields: {
     tagDescription: "An extensible platform for infrastructure management.",
+    archivalNotice: {
+      enabled: true,
+      title: "Archival Announcement",
+      message:
+        "Please be advised that the Clutch repository is slated to be deprecated and will be marked as archived and read-only. While all existing code will remain accessible, we will no longer accept new pull requests or issues after the archiving date and no new features or updates will be developed. If you have any questions or concerns, please reach out to clutch@lyft.com.",
+    },
     hero: {
       description:
         "Clutch provides everything you need to improve your developers' experience and operational capabilities. It comes with several out-of-the-box features for managing cloud-native infrastructure, but is easily configured or extended to interact with whatever you run, wherever you run it.",

docs/_website/src/pages/index.tsx

@@ -14,6 +14,25 @@ import {
   SiteConfig,
 } from "../theme/types";
 
+function ArchivalNotice(): JSX.Element | null {
+  const context = useDocusaurusContext();
+  const siteConfig = context.siteConfig as SiteConfig;
+  const notice = siteConfig.customFields.archivalNotice;
+
+  if (notice === undefined || notice === null || !notice.enabled) {
+    return null;
+  }
+
+  return (
+    <div className={classnames("alert alert--warning", styles.archivalNotice)}>
+      <div className="container">
+        <h4 style={{ marginBottom: "0.5rem" }}>{notice.title}</h4>
+        <p style={{ marginBottom: 0 }}>{notice.message}</p>
+      </div>
+    </div>
+  );
+}
+
 interface HeroProps extends Pick<SiteConfig, "tagline"> {
   config: HeroConfig;
 }
@@ -191,6 +210,7 @@ function Home(): JSX.Element {
       title={siteConfig.title}
       description={siteConfig.customFields.tagDescription}
     >
+      <ArchivalNotice />
       <Hero
         tagline={siteConfig.tagline}
         config={siteConfig.customFields.hero}

docs/_website/src/pages/styles.module.css

@@ -187,3 +187,16 @@
     text-align: center;
   }
 }
+
+.archivalNotice {
+  background-color: #fff3cd;
+  border-color: #ffeeba;
+  color: #856404;
+  padding: 1rem 0;
+  margin-bottom: 0;
+}
+
+.archivalNotice h4 {
+  color: #856404;
+  font-weight: 600;
+}

docs/_website/src/theme/types.tsx

@@ -47,6 +47,11 @@ export interface SiteConfig extends DocusaurusConfig {
     };
     tagDescription: string;
     hero: HeroConfig;
+    archivalNotice?: {
+      enabled: boolean;
+      title: string;
+      message: string;
+    };
   };
 }