From 835ab8b2482aec4df71ab3f955c75666780f988b Mon Sep 17 00:00:00 2001
From: Yassine Doghri <yassine@doghri.fr>
Date: Thu, 7 Nov 2024 12:11:50 +0000
Subject: [PATCH] docs(user-guide): update links for consistency + remove
missing monetization links
---
docs/astro.config.mjs | 10 ++--------
.../content/docs/en/getting-started/create-podcast.mdx | 6 +++---
docs/src/content/docs/en/getting-started/update.mdx | 2 +-
docs/src/content/docs/en/index.mdx | 2 +-
.../content/docs/en/user-guide/instance/fediverse.mdx | 4 ++--
.../content/docs/en/user-guide/instance/persons.mdx | 2 +-
.../instance/{add-podcast.mdx => podcast.mdx} | 8 ++++----
docs/src/content/docs/en/user-guide/instance/users.mdx | 4 ++--
.../docs/en/user-guide/podcast/contributors.mdx | 2 +-
.../content/docs/en/user-guide/podcast/dashboard.mdx | 6 +++---
docs/src/content/docs/en/user-guide/podcast/index.mdx | 1 -
docs/src/content/docs/en/user-guide/website/index.mdx | 6 +++---
12 files changed, 23 insertions(+), 30 deletions(-)
rename docs/src/content/docs/en/user-guide/instance/{add-podcast.mdx => podcast.mdx} (95%)
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
index 2dd7da1eb4..11a3906b49 100644
--- a/docs/astro.config.mjs
+++ b/docs/astro.config.mjs
@@ -211,7 +211,7 @@ export default defineConfig({
},
{
label: "Add a podcast",
- link: "/user-guide/instance/add-podcast",
+ link: "/user-guide/instance/podcast",
translations: {},
},
{
@@ -271,11 +271,6 @@ export default defineConfig({
link: "/user-guide/podcast/broadcast",
translations: {},
},
- {
- label: "Monetization",
- link: "/user-guide/podcast/monetization",
- translations: {},
- },
{
label: "Contributors",
link: "/user-guide/podcast/contributors",
@@ -292,8 +287,7 @@ export default defineConfig({
},
],
editLink: {
- baseUrl:
- "https://code.castopod.org/adaures/castopod/-/edit/develop/docs/",
+ baseUrl: "https://code.castopod.org/adaures/castopod/-/edit/main/docs/",
},
}),
tailwind({
diff --git a/docs/src/content/docs/en/getting-started/create-podcast.mdx b/docs/src/content/docs/en/getting-started/create-podcast.mdx
index 26a703e900..ef7c7a7401 100644
--- a/docs/src/content/docs/en/getting-started/create-podcast.mdx
+++ b/docs/src/content/docs/en/getting-started/create-podcast.mdx
@@ -54,7 +54,7 @@ You can choose a second category in addition to the main category you set up.
### Parental advisory
Choose if your podcast has explicit content or swearing or choose Clean if your podcast is suitable for everyone. You
-can also choose to leave this category as undefined. When [creating a new episode](../podcast/episodes.md),
+can also choose to leave this category as undefined. When [creating a new episode](../podcast/episodes),
you will also have the opportunity to choose clean, explicit, or undefined on a per episode basis.
## Author
@@ -78,7 +78,7 @@ You can optionally add the copyright holder in this field.
Enter the handle (or nickname) for your podcast. This will allow people on Mastodon and other Fediverse services
to follow your podcast. Your handle will be shown as @yourdomain.com@handle on the Fediverse.
-To learn more about Fediverse integration, visit the [Fediverse documentation page](../instance/fediverse.md).
+To learn more about Fediverse integration, visit the [Fediverse documentation page](../instance/fediverse).
### Podcast banner
@@ -99,7 +99,7 @@ listens over time, episode comparison charts, and more.
## Location
You can optionally add a real or fictitious location name in this field. When
-[creating a new episode](../podcast/episodes.md) you also can add a location to an individual episode.
+[creating a new episode](../podcast/episodes) you also can add a location to an individual episode.
## Advanced Parameters
diff --git a/docs/src/content/docs/en/getting-started/update.mdx b/docs/src/content/docs/en/getting-started/update.mdx
index f1a2697444..20dfbd0936 100644
--- a/docs/src/content/docs/en/getting-started/update.mdx
+++ b/docs/src/content/docs/en/getting-started/update.mdx
@@ -38,7 +38,7 @@ improvements ⚡.
<Aside>
You may need to reset files permissions as during the install process.
- Check [Security Concerns](./security.md).
+ Check [Security Concerns](./security).
</Aside>
diff --git a/docs/src/content/docs/en/index.mdx b/docs/src/content/docs/en/index.mdx
index 1a8364b990..299d236eb1 100644
--- a/docs/src/content/docs/en/index.mdx
+++ b/docs/src/content/docs/en/index.mdx
@@ -150,7 +150,7 @@ to get you started.
Castopod has adopted a Code of Conduct that we expect project participants to
adhere to. Please read the
-[CODE_OF_CONDUCT manual](https://code.castopod.org/adaures/castopod/-/blob/beta/CODE_OF_CONDUCT.md)
+[CODE_OF_CONDUCT manual](https://code.castopod.org/adaures/castopod/-/blob/develop/CODE_OF_CONDUCT.md)
so that you can understand what actions will and will not be tolerated.
### Contributing guide
diff --git a/docs/src/content/docs/en/user-guide/instance/fediverse.mdx b/docs/src/content/docs/en/user-guide/instance/fediverse.mdx
index c00db81225..00b83a217d 100644
--- a/docs/src/content/docs/en/user-guide/instance/fediverse.mdx
+++ b/docs/src/content/docs/en/user-guide/instance/fediverse.mdx
@@ -12,7 +12,7 @@ Wikipedia defines the Fediverse as:
Your podcast is connected to the Fediverse and, for example, Mastodon users can subscribe to your handle and will
receive a message every time your podcast publishes a new episode. You can also broadcast messages to your followers
-on the Fediverse from your [home page](../website/home.md). Mastodon users can like and share your posts.
+on the Fediverse from your [home page](../website#home). Mastodon users can like and share your posts.
## Manage Fediverse Blocks
@@ -21,7 +21,7 @@ You can block a Fediverse user or an entire domain to help stop harassment or sp
### Blocked Accounts
To block a specific Fediverse user, enter the user's handle in the **Account Handle** text box. It should be in
-the format of @user@domain.com. Press `Block` to block the user from following your podcast.
+the format of `@user@domain.com`. Press `Block` to block the user from following your podcast.
A list of all blocked accounts is shown below the **Account Handle** text box. You can choose to unblock a user
by pressing the `Unblock` button.
diff --git a/docs/src/content/docs/en/user-guide/instance/persons.mdx b/docs/src/content/docs/en/user-guide/instance/persons.mdx
index a7c5a9fde9..ce17ec1d46 100644
--- a/docs/src/content/docs/en/user-guide/instance/persons.mdx
+++ b/docs/src/content/docs/en/user-guide/instance/persons.mdx
@@ -19,4 +19,4 @@ corner of the **All Persons** page and fill out the following fields:
- **Unique Name**: Enter a unique username for the person you are adding. This will be displayed in the Podcasts
secton when assigning this person a role.
- **Information URL**: Enter a URL for the person's homepage, profile, or social media account to be linked from the
- [Credits page](../website/credits.md).
+ [Credits page](../website/credits).
diff --git a/docs/src/content/docs/en/user-guide/instance/add-podcast.mdx b/docs/src/content/docs/en/user-guide/instance/podcast.mdx
similarity index 95%
rename from docs/src/content/docs/en/user-guide/instance/add-podcast.mdx
rename to docs/src/content/docs/en/user-guide/instance/podcast.mdx
index ea33a9a641..8b9fd8fe6e 100644
--- a/docs/src/content/docs/en/user-guide/instance/add-podcast.mdx
+++ b/docs/src/content/docs/en/user-guide/instance/podcast.mdx
@@ -3,7 +3,7 @@ title: Create or import a podcast
---
You can create a new podcast or import an existing podcast into Castopod in the Podcasts section. If you are adding
-a second podcast to Castopod, see the [Home page documentation](../website/home.md) for how that will change your
+a second podcast to Castopod, see the [Home page documentation](../website#home-page) for how that will change your
home page.
From the left hand navigation sidebar, press the `+` sign to the right of Podcasts to create your first podcast.
@@ -56,7 +56,7 @@ You can choose a second category in addition to the main category you set up.
### Parental advisory
Choose if your podcast has explicit content or swearing or choose Clean if your podcast is suitable for everyone. You
-can also choose to leave this category as undefined. When [creating a new episode](../podcast/episodes.md),
+can also choose to leave this category as undefined. When [creating a new episode](../podcast/episodes),
you will also have the opportunity to choose clean, explicit, or undefined on a per episode basis.
## Author
@@ -80,7 +80,7 @@ You can optionally add the copyright holder in this field.
Enter the handle (or nickname) for your podcast. This will allow people on Mastodon and other Fediverse services
to follow your podcast. Your handle will be shown as @yourdomain.com@handle on the Fediverse.
-To learn more about Fediverse integration, visit the [Fediverse documentation page](../instance/fediverse.md).
+To learn more about Fediverse integration, visit the [Fediverse documentation page](../instance/fediverse).
### Podcast banner
@@ -101,7 +101,7 @@ listens over time, episode comparison charts, and more.
## Location
You can optionally add a real or fictitious location name in this field. When
-[creating a new episode](../podcast/episodes.md) you also can add a location to an individual episode.
+[creating a new episode](../podcast/episodes) you also can add a location to an individual episode.
## Advanced Parameters
diff --git a/docs/src/content/docs/en/user-guide/instance/users.mdx b/docs/src/content/docs/en/user-guide/instance/users.mdx
index ca75fc117b..1c48d32d8f 100644
--- a/docs/src/content/docs/en/user-guide/instance/users.mdx
+++ b/docs/src/content/docs/en/user-guide/instance/users.mdx
@@ -3,8 +3,8 @@ title: Users
---
Roles and permissions in Castopod are defined in two ways, **Instance** users and
-[**Podcast**. contributors](../podcast/contributors.md). For a detailed list of permissions, view
-he [Auth](/docs/en/getting-started/auth) page.
+[**Podcast**. contributors](../podcast/contributors). For a detailed list of permissions, view
+he [Auth](../../getting-started/auth) page.
## Adding a User to the instance
diff --git a/docs/src/content/docs/en/user-guide/podcast/contributors.mdx b/docs/src/content/docs/en/user-guide/podcast/contributors.mdx
index 95d783384d..e57971ee52 100644
--- a/docs/src/content/docs/en/user-guide/podcast/contributors.mdx
+++ b/docs/src/content/docs/en/user-guide/podcast/contributors.mdx
@@ -3,7 +3,7 @@ title: Contributors
---
From the podcast dashboard, click **Contributors** to add or edit users to have access to the podcast and its settings.
-For a detailed list of permissions, view the [Auth](/docs/en/getting-started/auth) page.
+For a detailed list of permissions, view the [Auth](../../getting-started/auth) page.
## Roles
diff --git a/docs/src/content/docs/en/user-guide/podcast/dashboard.mdx b/docs/src/content/docs/en/user-guide/podcast/dashboard.mdx
index 99b0575cce..4ec7e608cc 100644
--- a/docs/src/content/docs/en/user-guide/podcast/dashboard.mdx
+++ b/docs/src/content/docs/en/user-guide/podcast/dashboard.mdx
@@ -12,7 +12,7 @@ on any of these episodes to view them or click `See all episodes` to see a list
To edit your podcast, press `Edit podcast` in the upper right hand corner or `Edit podcast` in the left hand side
navigation.
-You can edit any of the [fields you filled out when creating your podcast](/docs/en/user-guide/instance/add-podcast).
+You can edit any of the [fields you filled out when creating your podcast](../instance/podcast).
When finished press the `Save podcast` button in the upper right hand corner.
@@ -21,7 +21,7 @@ You can also choose to delete your podcast by pressing `Delete podcast` at the b
## Manage persons
If you have added people to Persons in the Admin dashboard, you can assign them a role here. People assigned roles
-will show up on the [Credits page](/docs/en/user-guide/website/credits) linked from your home page to give them
+will show up on the [Credits page](../website/credits) linked from your home page to give them
credit for contributing to the podcast.
Roles include Administration, Audio production, cast, guests, hosts, writing, and more.
@@ -32,7 +32,7 @@ press `Add person(s)`.
A list of all people assigned roles will be displayed. You can remove them by pressing the `Remove` button.
Adding persons to your podcast populates the Credits page linked from your
-[home page](/docs/en/user-guide/website/index.md).
+[home page](../website).
## Podcast imports
diff --git a/docs/src/content/docs/en/user-guide/podcast/index.mdx b/docs/src/content/docs/en/user-guide/podcast/index.mdx
index 2e8e0b73b3..8f8eb2d13a 100644
--- a/docs/src/content/docs/en/user-guide/podcast/index.mdx
+++ b/docs/src/content/docs/en/user-guide/podcast/index.mdx
@@ -15,6 +15,5 @@ by clicking the links below.
<LinkCard title="Episodes" href="episodes" />
<LinkCard title="Analytics" href="analytics" />
<LinkCard title="Broadcast" href="broadcast" />
- <LinkCard title="Monetization" href="monetization" />
<LinkCard title="Contributors" href="contributors" />
</CardGrid>
diff --git a/docs/src/content/docs/en/user-guide/website/index.mdx b/docs/src/content/docs/en/user-guide/website/index.mdx
index 06675a5c01..fe5bdd1d67 100644
--- a/docs/src/content/docs/en/user-guide/website/index.mdx
+++ b/docs/src/content/docs/en/user-guide/website/index.mdx
@@ -33,12 +33,12 @@ podcast app.
### Social Networks
Below the RSS feed is are icons that link to all of the social networks you toggled on in the
-[Broadcast](/docs/en/user-guide/podcast/broadcast#podcasting-apps) section of the podcast's admin section.
+[Broadcast](../podcast/broadcast#podcasting-apps) section of the podcast's admin section.
### Podcast Directories
Below the social networking links is **Listen On** which displays icons linked to the podcast directories you
-toggled on in the [Broadcast](/docs/en/user-guide/podcast/broadcast#social-networks) section of the podcast's
+toggled on in the [Broadcast](../podcast/broadcast#social-networks) section of the podcast's
admin section.
## Activity
@@ -67,7 +67,7 @@ The About tab shares general information about your podcast, including:
- Podcast description
- Podcast category
-- The [people](/docs/en/user-guide/podcast/podcast-dashboard#manage-persons/) who contribute to the podcast
+- The [people](../podcast/dashboard#manage-persons) who contribute to the podcast
- Statistics
- Number of seasons
- Number of episodes
--
GitLab