From 8e9aeffd78c163bdc3cd5d8b4c56200b849f46c9 Mon Sep 17 00:00:00 2001
From: Ben Halpern <bendhalpern@gmail.com>
Date: Fri, 9 Oct 2020 14:13:14 -0400
Subject: [PATCH] Add forem meta tags (#10747)

* Add forem meta tags

* Add docs

* Update docs/technical-overview/compatibility.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>

* Update docs/technical-overview/compatibility.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>

* Update docs/technical-overview/compatibility.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>

* Update docs/technical-overview/compatibility.md

Co-authored-by: Jacob Herrington <jacobherringtondeveloper@gmail.com>
---
 app/views/shell/_top.html.erb            |  4 ++++
 docs/technical-overview/compatibility.md | 22 ++++++++++++++++++++++
 docs/technical-overview/readme.md        |  1 +
 3 files changed, 27 insertions(+)
 create mode 100644 docs/technical-overview/compatibility.md

diff --git a/app/views/shell/_top.html.erb b/app/views/shell/_top.html.erb
index fa4ba2fc8..2beb17d5c 100644
--- a/app/views/shell/_top.html.erb
+++ b/app/views/shell/_top.html.erb
@@ -46,6 +46,10 @@
       <meta name="theme-color" content="#000000" />
       <link rel="manifest" href="/manifest.json" />
       <link rel="search" href="<%= URL.url("open-search.xml") %>" type="application/opensearchdescription+xml" title="<%= community_qualified_name %>" />
+
+      <meta property="forem:name" content="<%= community_name %>" />
+      <meta property="forem:logo" content="<%= optimized_image_url(SiteConfig.logo_png, width: 512, fetch_format: "png") %>" />
+      <meta property="forem:domain" content="<%= SiteConfig.app_domain %>" />
     <% end %>
   </head>
   <% unless internal_navigation? %>
diff --git a/docs/technical-overview/compatibility.md b/docs/technical-overview/compatibility.md
new file mode 100644
index 000000000..d427721cd
--- /dev/null
+++ b/docs/technical-overview/compatibility.md
@@ -0,0 +1,22 @@
+# Compatibility
+
+To go along with effective administration and putting user security and well-being first, for a Forem to be most useful, it maximizes its technical compatibility.
+
+Compatability means:
+
+- Staying updated. We need to maintain overall compatability by keeping the ecosystem close to the latest version as proactively as we can.
+- Maintaining all programmatic interfaces, whether they be the [API](https://api.forem.com) or Forem meta tags which can be consumed for Forem validation.
+- Maintaining human interfaces which allow users to find where they need to go and conduct all necessary customizations.
+- Maintaining great performance such that the web-based Forem ecosystem can provide a great experience in all network conditions and in comparison to more closed ecosystems.
+
+## Meta tags
+
+The canonical meta tags which are expected to be present as a component of validation are as follows:
+
+```html
+<meta property="forem:name" content="My great friends" />
+<meta property="forem:logo" content="https://mygreatfriends.com/logo.png" />
+<meta property="forem:domain" content="mygreatfriends.com" />
+```
+
+This list may evolve over time. If you want to propose a new meta tag which could improve the efficacy of an ecosystem app, please feel free to open an issue or a discussion on [forem.dev](https://forem.dev).
diff --git a/docs/technical-overview/readme.md b/docs/technical-overview/readme.md
index eea7411be..74f84e3d7 100644
--- a/docs/technical-overview/readme.md
+++ b/docs/technical-overview/readme.md
@@ -3,6 +3,7 @@ items:
   - stack.md
   - architecture.md
   - feed.md
+  - compatibility.md
 ---
 
 # Technical Overview