From 4c007efa9b01d8854774d9f636cbb721e4b2a6d7 Mon Sep 17 00:00:00 2001 From: FloatingGhost Date: Fri, 15 Jul 2022 11:33:30 +0100 Subject: [PATCH] direct docs to stable --- README.md | 26 +++++++++---------- installation/apache/akkoma-apache.conf | 2 +- lib/mix/tasks/pleroma/app.ex | 2 +- lib/mix/tasks/pleroma/config.ex | 2 +- lib/mix/tasks/pleroma/database.ex | 2 +- lib/mix/tasks/pleroma/digest.ex | 2 +- lib/mix/tasks/pleroma/email.ex | 2 +- lib/mix/tasks/pleroma/emoji.ex | 2 +- lib/mix/tasks/pleroma/frontend.ex | 2 +- lib/mix/tasks/pleroma/instance.ex | 2 +- lib/mix/tasks/pleroma/relay.ex | 2 +- lib/mix/tasks/pleroma/uploads.ex | 2 +- lib/mix/tasks/pleroma/user.ex | 2 +- lib/pleroma/docs/json.ex | 2 +- lib/pleroma/docs/markdown.ex | 2 +- .../READ_THIS_BEFORE_TOUCHING_FILES_HERE | 2 +- priv/static/index.html | 2 +- 17 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 69a3d48ee..38ca76003 100644 --- a/README.md +++ b/README.md @@ -8,27 +8,27 @@ This is a fork of Pleroma, which is a microblogging server software that can fed Akkoma is written in Elixir and uses PostgresSQL for data storage. -For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on ). +For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on ). -- [Client Applications for Pleroma](https://docs.akkoma.dev/main/backend/clients/) +- [Client Applications for Pleroma](https://docs.akkoma.dev/stable/clients/) ## Installation ### OTP releases (Recommended) -If you are running Linux (glibc or musl) on x86, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs.akkoma.dev/main/backend/installation/otp_en/). +If you are running Linux (glibc or musl) on x86, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available [here](https://docs.akkoma.dev/stable/installation/otp_en/). ### From Source If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source. -- [Alpine Linux](https://docs.akkoma.dev/main/backend/installation/alpine_linux_en/) -- [Arch Linux](https://docs.akkoma.dev/main/backend/installation/arch_linux_en/) -- [Debian-based](https://docs.akkoma.dev/main/backend/installation/debian_based_en/) -- [Debian-based (jp)](https://docs.akkoma.dev/main/backend/installation/debian_based_jp/) -- [FreeBSD](https://docs.akkoma.dev/main/backend/installation/freebsd_en/) -- [Gentoo Linux](https://docs.akkoma.dev/main/backend/installation/gentoo_en/) -- [NetBSD](https://docs.akkoma.dev/main/backend/installation/netbsd_en/) -- [OpenBSD](https://docs.akkoma.dev/main/backend/installation/openbsd_en/) -- [OpenBSD (fi)](https://docs.akkoma.dev/main/backend/installation/openbsd_fi/) +- [Alpine Linux](https://docs.akkoma.dev/stable/installation/alpine_linux_en/) +- [Arch Linux](https://docs.akkoma.dev/stable/installation/arch_linux_en/) +- [Debian-based](https://docs.akkoma.dev/stable/installation/debian_based_en/) +- [Debian-based (jp)](https://docs.akkoma.dev/stable/installation/debian_based_jp/) +- [FreeBSD](https://docs.akkoma.dev/stable/installation/freebsd_en/) +- [Gentoo Linux](https://docs.akkoma.dev/stable/installation/gentoo_en/) +- [NetBSD](https://docs.akkoma.dev/stable/installation/netbsd_en/) +- [OpenBSD](https://docs.akkoma.dev/stable/installation/openbsd_en/) +- [OpenBSD (fi)](https://docs.akkoma.dev/stable/installation/openbsd_fi/) ### Docker While we don’t provide docker files, other people have written very good ones. Take a look at or . @@ -42,4 +42,4 @@ If you ever encounter compilation issues during the updating of Pleroma, you can - `rm -r _build` ## Documentation -- https://docs.akkoma.dev/main +- https://docs.akkoma.dev/stable diff --git a/installation/apache/akkoma-apache.conf b/installation/apache/akkoma-apache.conf index c9f123532..65bbf15e1 100644 --- a/installation/apache/akkoma-apache.conf +++ b/installation/apache/akkoma-apache.conf @@ -8,7 +8,7 @@ # 'a2ensite akkoma-apache.conf', then restart Apache. # # Optional: enable disk-based caching for the media proxy -# For details, see https://docs.akkoma.dev/main/backend/configuration/howto_mediaproxy/ +# For details, see https://docs.akkoma.dev/stable/configuration/howto_mediaproxy/ # # 1. Create a directory as shown below for the CacheRoot and make sure # the Apache user can write to it. diff --git a/lib/mix/tasks/pleroma/app.ex b/lib/mix/tasks/pleroma/app.ex index 0bf7ffabc..2ec06db8c 100644 --- a/lib/mix/tasks/pleroma/app.ex +++ b/lib/mix/tasks/pleroma/app.ex @@ -3,7 +3,7 @@ # SPDX-License-Identifier: AGPL-3.0-only defmodule Mix.Tasks.Pleroma.App do - @moduledoc File.read!("docs/administration/CLI_tasks/oauth_app.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/oauth_app.md") use Mix.Task import Mix.Pleroma diff --git a/lib/mix/tasks/pleroma/config.ex b/lib/mix/tasks/pleroma/config.ex index 05ff8076f..c259a6cbd 100644 --- a/lib/mix/tasks/pleroma/config.ex +++ b/lib/mix/tasks/pleroma/config.ex @@ -12,7 +12,7 @@ defmodule Mix.Tasks.Pleroma.Config do alias Pleroma.Repo @shortdoc "Manages the location of the config" - @moduledoc File.read!("docs/administration/CLI_tasks/config.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/config.md") def run(["migrate_to_db"]) do check_configdb(fn -> diff --git a/lib/mix/tasks/pleroma/database.ex b/lib/mix/tasks/pleroma/database.ex index a973beaa9..99897e83e 100644 --- a/lib/mix/tasks/pleroma/database.ex +++ b/lib/mix/tasks/pleroma/database.ex @@ -18,7 +18,7 @@ defmodule Mix.Tasks.Pleroma.Database do use Mix.Task @shortdoc "A collection of database related tasks" - @moduledoc File.read!("docs/administration/CLI_tasks/database.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/database.md") def run(["remove_embedded_objects" | args]) do {options, [], []} = diff --git a/lib/mix/tasks/pleroma/digest.ex b/lib/mix/tasks/pleroma/digest.ex index f34fc839e..0c1469432 100644 --- a/lib/mix/tasks/pleroma/digest.ex +++ b/lib/mix/tasks/pleroma/digest.ex @@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Digest do import Mix.Pleroma @shortdoc "Manages digest emails" - @moduledoc File.read!("docs/administration/CLI_tasks/digest.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/digest.md") def run(["test", nickname | opts]) do Mix.Pleroma.start_pleroma() diff --git a/lib/mix/tasks/pleroma/email.ex b/lib/mix/tasks/pleroma/email.ex index 4ce8c9b05..d257cebe9 100644 --- a/lib/mix/tasks/pleroma/email.ex +++ b/lib/mix/tasks/pleroma/email.ex @@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Email do import Mix.Pleroma @shortdoc "Email administrative tasks" - @moduledoc File.read!("docs/administration/CLI_tasks/email.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/email.md") def run(["test" | args]) do start_pleroma() diff --git a/lib/mix/tasks/pleroma/emoji.ex b/lib/mix/tasks/pleroma/emoji.ex index 9ad4a7467..5dedf276a 100644 --- a/lib/mix/tasks/pleroma/emoji.ex +++ b/lib/mix/tasks/pleroma/emoji.ex @@ -7,7 +7,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do import Mix.Pleroma @shortdoc "Manages emoji packs" - @moduledoc File.read!("docs/administration/CLI_tasks/emoji.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/emoji.md") def run(["ls-packs" | args]) do start_pleroma() diff --git a/lib/mix/tasks/pleroma/frontend.ex b/lib/mix/tasks/pleroma/frontend.ex index 8334e0049..d265bfa3a 100644 --- a/lib/mix/tasks/pleroma/frontend.ex +++ b/lib/mix/tasks/pleroma/frontend.ex @@ -9,7 +9,7 @@ defmodule Mix.Tasks.Pleroma.Frontend do @shortdoc "Manages bundled Pleroma frontends" - @moduledoc File.read!("docs/administration/CLI_tasks/frontend.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/frontend.md") def run(["install", "none" | _args]) do shell_info("Skipping frontend installation because none was requested") diff --git a/lib/mix/tasks/pleroma/instance.ex b/lib/mix/tasks/pleroma/instance.ex index 03f72c27a..8954b3b7c 100644 --- a/lib/mix/tasks/pleroma/instance.ex +++ b/lib/mix/tasks/pleroma/instance.ex @@ -9,7 +9,7 @@ defmodule Mix.Tasks.Pleroma.Instance do alias Pleroma.Config @shortdoc "Manages Pleroma instance" - @moduledoc File.read!("docs/administration/CLI_tasks/instance.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/instance.md") def run(["gen" | rest]) do {options, [], []} = diff --git a/lib/mix/tasks/pleroma/relay.ex b/lib/mix/tasks/pleroma/relay.ex index 01e6b4279..c32fcdc33 100644 --- a/lib/mix/tasks/pleroma/relay.ex +++ b/lib/mix/tasks/pleroma/relay.ex @@ -8,7 +8,7 @@ defmodule Mix.Tasks.Pleroma.Relay do alias Pleroma.Web.ActivityPub.Relay @shortdoc "Manages remote relays" - @moduledoc File.read!("docs/administration/CLI_tasks/relay.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/relay.md") def run(["follow", target]) do start_pleroma() diff --git a/lib/mix/tasks/pleroma/uploads.ex b/lib/mix/tasks/pleroma/uploads.ex index 333e9aa8e..e8c69dddc 100644 --- a/lib/mix/tasks/pleroma/uploads.ex +++ b/lib/mix/tasks/pleroma/uploads.ex @@ -12,7 +12,7 @@ defmodule Mix.Tasks.Pleroma.Uploads do @log_every 50 @shortdoc "Migrates uploads from local to remote storage" - @moduledoc File.read!("docs/administration/CLI_tasks/uploads.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/uploads.md") def run(["migrate_local", target_uploader | args]) do delete? = Enum.member?(args, "--delete") diff --git a/lib/mix/tasks/pleroma/user.ex b/lib/mix/tasks/pleroma/user.ex index 6c26e0e95..f8c6d5781 100644 --- a/lib/mix/tasks/pleroma/user.ex +++ b/lib/mix/tasks/pleroma/user.ex @@ -13,7 +13,7 @@ defmodule Mix.Tasks.Pleroma.User do alias Pleroma.Web.ActivityPub.Pipeline @shortdoc "Manages Pleroma users" - @moduledoc File.read!("docs/administration/CLI_tasks/user.md") + @moduledoc File.read!("docs/docs/administration/CLI_tasks/user.md") def run(["new", nickname, email | rest]) do {options, [], []} = diff --git a/lib/pleroma/docs/json.ex b/lib/pleroma/docs/json.ex index f22432ea4..a94c6a472 100644 --- a/lib/pleroma/docs/json.ex +++ b/lib/pleroma/docs/json.ex @@ -25,7 +25,7 @@ defmodule Pleroma.Docs.JSON do @spec process(keyword()) :: {:ok, String.t()} def process(descriptions) do - with path <- "docs/generated_config.json", + with path <- "docs/docs/generated_config.json", {:ok, file} <- File.open(path, [:write, :utf8]), formatted_descriptions <- Pleroma.Docs.Generator.convert_to_strings(descriptions), diff --git a/lib/pleroma/docs/markdown.ex b/lib/pleroma/docs/markdown.ex index 7e54e9d58..0a7b826ab 100644 --- a/lib/pleroma/docs/markdown.ex +++ b/lib/pleroma/docs/markdown.ex @@ -7,7 +7,7 @@ defmodule Pleroma.Docs.Markdown do @spec process(keyword()) :: {:ok, String.t()} def process(descriptions) do - config_path = "docs/generated_config.md" + config_path = "docs/docs/generated_config.md" {:ok, file} = File.open(config_path, [:utf8, :write]) IO.write(file, "# Generated configuration\n") IO.write(file, "Date of generation: #{Date.utc_today()}\n\n") diff --git a/priv/static/READ_THIS_BEFORE_TOUCHING_FILES_HERE b/priv/static/READ_THIS_BEFORE_TOUCHING_FILES_HERE index 5d94e5ec0..2f223927d 100644 --- a/priv/static/READ_THIS_BEFORE_TOUCHING_FILES_HERE +++ b/priv/static/READ_THIS_BEFORE_TOUCHING_FILES_HERE @@ -5,4 +5,4 @@ modifying anything here. Please use the instance static directory instead, it has the same directory structure and files placed there will override files placed here. See -https://docs.akkoma.dev/main/backend/configuration/static_dir/ for more info. +https://docs.akkoma.dev/stable/configuration/static_dir/ for more info. diff --git a/priv/static/index.html b/priv/static/index.html index dd507f6ea..4a304f576 100644 --- a/priv/static/index.html +++ b/priv/static/index.html @@ -7,6 +7,6 @@

Welcome to Akkoma!

If you're seeing this page, your server works!

In order to get a frontend to show here, you'll need to set up :pleroma, :frontends, primary and install your frontend of choice

- Documentation + Documentation