Merge pull request #25341 from backstage/freben/no-about

document suggestion to fork AboutCard if needed

.changeset/soft-clocks-bake.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog': patch
+---
+
+Added small notes to AboutCard to discourage customizability PRs

plugins/catalog/api-report.md

@@ -334,7 +334,7 @@ export interface DependsOnResourcesCardProps {
   variant?: InfoCardVariants;
 }
 
-// @public (undocumented)
+// @public
 export const EntityAboutCard: (props: AboutCardProps) => JSX.Element;
 
 // @public (undocumented)

plugins/catalog/src/components/AboutCard/AboutCard.tsx

@@ -100,6 +100,10 @@ export interface AboutCardProps {
 
 /**
  * Exported publicly via the EntityAboutCard
+ *
+ * NOTE: We generally do not accept pull requests to extend this class with more
+ * props and cusomizability. If you need to tweak it, consider making a bespoke
+ * card in your own repository instead, that is perfect for your own needs.
  */
 export function AboutCard(props: AboutCardProps) {
   const { variant } = props;

plugins/catalog/src/plugin.ts

@@ -115,7 +115,18 @@ export const CatalogEntityPage: () => JSX.Element = catalogPlugin.provide(
   }),
 );
 
-/** @public */
+/**
+ * An example About card to show at the top of entity pages.
+ *
+ * @public
+ * @remarks
+ *
+ * This card collects some high level information about the entity, but is just
+ * an example component. Many organizations will want to replace it with a
+ * custom card that is more tailored to their specific needs. The card itself is
+ * not extremely customizable; feel free to make a copy of it as a starting
+ * point if you like.
+ */
 export const EntityAboutCard: (props: AboutCardProps) => JSX.Element =
   catalogPlugin.provide(
     createComponentExtension({