Add Github social media preview image (#36653)

(cherry picked from commit a039cfb)
apache · Jan 11, 2024 · 79e54c9 · 79e54c9
1 parent 718f802
commit 79e54c9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.asf.yaml b/.asf.yaml
@@ -20,7 +20,13 @@
 github:
   description: "Apache Airflow - A platform to programmatically author, schedule, and monitor workflows"
   homepage: https://airflow.apache.org/
+  # Social media preview image is not supported by Github API/asf.yaml, need to be uploaded
+  # manually in Github repository --> Settings --> click "Edit" in "Social preview"
+  # See also:
+  # https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview
+  # social_media_preview: docs/apache-airflow/img/logos/github_repository_social_image.png
   labels:
+    # Note that Github only supports <=20 labels/topics per repo! Pipeline will fail if you add more.
     - airflow
     - apache
     - apache-airflow

diff --git a/docs/apache-airflow/img/logos/github_repository_social_image.png b/docs/apache-airflow/img/logos/github_repository_social_image.png