Skip to content

Commit

Permalink
feat: split up overview and add CoC link.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sporiff
Sporiff committed Sep 5, 2023
1 parent 2a16cd3 commit 86c2b6f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 14 deletions.
3 changes: 3 additions & 0 deletions astro.config.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ export default defineConfig({
label: "Project overview",
link: "overview"
}, {
label: "Project information",
link: "info"
}, {
label: "Specifications",
items: [
{
Expand Down
22 changes: 22 additions & 0 deletions src/content/docs/info.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Project information
description: An introduction to the Open Podcast API project
sidebar:
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.

The initial discussions on GitHub led to a meeting in October 2022 with contributors from [AntennaPod](https://github.com/AntennaPod/AntennaPod/), [Funkwhale](https://dev.funkwhale.audio/), [Kasts](https://invent.kde.org/multimedia/kasts), [Podfriend](https://github.com/MartinMouritzen/Podfriend) and the [gPodder app for Nextcloud](https://github.com/thrillfall/nextcloud-gpodder).[^initialAPIdiscussions] A few months later, the first of the recurring meetings took place to start developing the specification.

## Code of conduct

The Open Podcast API project abides by the Funkwhale code of conduct. Please familiarize yourself with it before participating in any of our community spaces.

<LinkCard title="Code of conduct" description="Read the code of conduct on Funkwhale's website" href="https://funkwhale.audio/en_US/code-of-conduct"/>

[^gPoddermaintainer]: [Call on the gPodder.net repository for a new maintainer](https://github.com/gpodder/mygpo/blob/81e3d13e00e6c3d6db7ee6a22734041bf6fde128/maintainer-needed.md)
[^APforumGpodderIssues]: [Questions about gPodder.net issues on the AntennaPod forum](https://forum.antennapod.org/t/problem-with-gpodder-net/374)
[^gPodder50x]: [Issue in the gPodder.net repository on 502 errors](https://github.com/gpodder/mygpo/issues/527)
[^APforumGpodderRemoval]: [Suggestion on the AntennaPod forum to remove gPodder.net support](https://forum.antennapod.org/t/should-gpodder-net-be-supported-long-term/396)
[^initialAPIdiscussions]: [Initial discussions on the needs for a new podcast synchronisation API](https://github.com/thrillfall/nextcloud-gpodder/discussions/91)
16 changes: 2 additions & 14 deletions src/content/docs/overview.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
---
title: Project overview
description: An introduction to the Open Podcast API project
description: An overview of the project
sidebar:
order: 1
order: 2
---

## Background

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.

The initial discussions on GitHub led to a meeting in October 2022 with contributors from [AntennaPod](https://github.com/AntennaPod/AntennaPod/), [Funkwhale](https://dev.funkwhale.audio/), [Kasts](https://invent.kde.org/multimedia/kasts), [Podfriend](https://github.com/MartinMouritzen/Podfriend) and the [gPodder app for Nextcloud](https://github.com/thrillfall/nextcloud-gpodder).[^initialAPIdiscussions] A few months later, the first of the recurring meetings took place to start developing the specification.

## Supported features

:::caution[Important]
Expand All @@ -30,9 +24,3 @@ To ensure that the end-user experience is consistent across implemenetations, th
: The feature or endpoint is considered to be additional functionality. Clients and servers may optionally support any combination of these features. Any project implementing **Optional** functionality should inform users about what is supported.

**Core** features are determined during the specification process. They are subject to change, although a change is unlikely.

[^gPoddermaintainer]: [Call on the gPodder.net repository for a new maintainer](https://github.com/gpodder/mygpo/blob/81e3d13e00e6c3d6db7ee6a22734041bf6fde128/maintainer-needed.md)
[^APforumGpodderIssues]: [Questions about gPodder.net issues on the AntennaPod forum](https://forum.antennapod.org/t/problem-with-gpodder-net/374)
[^gPodder50x]: [Issue in the gPodder.net repository on 502 errors](https://github.com/gpodder/mygpo/issues/527)
[^APforumGpodderRemoval]: [Suggestion on the AntennaPod forum to remove gPodder.net support](https://forum.antennapod.org/t/should-gpodder-net-be-supported-long-term/396)
[^initialAPIdiscussions]: [Initial discussions on the needs for a new podcast synchronisation API](https://github.com/thrillfall/nextcloud-gpodder/discussions/91)

0 comments on commit 86c2b6f

Please sign in to comment.