Add CoC to main site

OpenPodcastAPI · Jan 28, 2024 · 0e5ca70 · 0e5ca70
1 parent 359c2be
commit 0e5ca70
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 53 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -2,59 +2,76 @@ import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
 import AutoImport from "astro-auto-import";
 import {
-	remarkDefinitionList,
-	defListHastHandlers,
+  remarkDefinitionList,
+  defListHastHandlers,
 } from "remark-definition-list";
 
 // https://astro.build/config
 export default defineConfig({
-	integrations: [
-		starlight({
-			title: "Open Podcast API",
-			favicon: "favicon.ico",
-			social: {
-				github: "https://github.com/OpenPodcastApi/api-specs"
-			},
-			sidebar: [{
-				label: "Project overview",
-				link: "about"
-			}, {
-				label: "Specifications",
-				items: [
-					{
-						label: "Introduction",
-						link: "specs"
-					},
-					{
-						label: "Subscriptions",
-						collapsed: true,
-						autogenerate: {
-							directory: "specs/subscriptions"
-						}
-					}]
-			},
-			{
-				label: "API explorer",
-				link: "rapidoc.html"
-			}]
-		}),
-		AutoImport({
-			imports: [
-				{ "@astrojs/starlight/components": ["Card", "CardGrid", "LinkCard", "Tabs", "TabItem"] }
-			]
-		})],
-	// Process images with sharp: https://docs.astro.build/en/guides/assets/#using-sharp
-	image: {
-		service: {
-			entrypoint: "astro/assets/services/sharp"
-		}
-	},
-	markdown: {
-		remarkPlugins: [remarkDefinitionList],
-		remarkRehype: {
-			handlers: {
-				...defListHastHandlers,
-			},
-		},
-	}
+  integrations: [
+    starlight({
+      title: "Open Podcast API",
+      favicon: "favicon.ico",
+      social: {
+        github: "https://github.com/OpenPodcastApi/api-specs",
+      },
+      sidebar: [
+        {
+          label: "Project overview",
+          link: "about",
+        },
+        {
+          label: "Code of conduct",
+          link: "coc",
+        },
+        {
+          label: "Specifications",
+          items: [
+            {
+              label: "Introduction",
+              link: "specs",
+            },
+            {
+              label: "Subscriptions",
+              collapsed: true,
+              autogenerate: {
+                directory: "specs/subscriptions",
+              },
+            },
+          ],
+        },
+        {
+          label: "API explorer",
+          link: "rapidoc.html",
+        },
+      ],
+    }),
+    AutoImport({
+      imports: [
+        {
+          "@astrojs/starlight/components": [
+            "Card",
+            "CardGrid",
+            "LinkCard",
+            "Tabs",
+            "TabItem",
+          ],
+        },
+      ],
+    }),
+  ],
+  // Process images with sharp: https://docs.astro.build/en/guides/assets/#using-sharp
+  image: {
+    service: {
+      entrypoint: "astro/assets/services/sharp",
+    },
+  },
+  markdown: {
+    remarkPlugins: [remarkDefinitionList],
+    remarkRehype: {
+      handlers: {
+        ...defListHastHandlers,
+      },
+    },
+  },
 });
diff --git a/src/content/docs/about.mdx b/src/content/docs/about.mdx
@@ -2,7 +2,7 @@
 title: Project overview
 description: An introduction to the Open Podcast API project
 sidebar:
-   order: 1
+  order: 1
 ---
 
 The Open Podcast API project is inspired by and builds upon the [gPodder API](https://gpoddernet.readthedocs.io/en/latest/api/index.html). In the summer of 2019, the creator of gPodder announced they were stepping down and the community took over.[^gPoddermaintainer] Unfortunately, about a year later the project entered 'basic maintenance mode' due to shifting priorities of key contributors. The limited availability of volunteers combined with gPodder.net's popularity among end-users meant that people started to see server errors while synchronizing or creating an account.[^APforumGpodderIssues] [^gPodder50x] Attempts to establish contact and collaborate on improving the situation didn't work out as hoped. Given the situation, AntennaPod contributors started discussing whether gPodder.net support should be removed[^APforumGpodderRemoval] or whether it could be forked. They concluded that the best solution would be to create a new API spec with a broad range of contributors to allow users to switch servers (avoiding major loads on a single server or project), to provide an opportunity to more easily go beyond the existing gPodder.net API specs, and to enable developers to address some technical issues with the API specs.
@@ -15,7 +15,7 @@ We encourage you to engage in the discussions, and provide feedback based on you
 
 ## Code of Conduct
 
-The Open Podcast API project abides by the [Funkwhale Code of Conduct](https://funkwhale.audio/en_US/code-of-conduct). Please familiarize yourself with it before participating in any of our community spaces.
+The Open Podcast API project abides by the [Contributor Covenant Code of Conduct](/coc). Please familiarize yourself with it before participating in any of our community spaces.
 
 ## Our infrastructure: powered by …
 

diff --git a/src/content/docs/coc.mdx b/src/content/docs/coc.mdx
@@ -0,0 +1,8 @@
+---
+title: Code of conduct
+description: Read this carefully before interacting with the project.
+---
+
+import CoC from "../../../CODE_OF_CONDUCT.md";
+
+<CoC />