From 23ee94c0d8d568354d98799315140c62557b52a6 Mon Sep 17 00:00:00 2001 From: solidsanek Date: Sat, 10 May 2025 17:14:36 +0200 Subject: [PATCH] docs: use highlight blocks where appropriate --- docs/docs/administration/CLI_tasks/config.md | 12 +++++++----- docs/docs/configuration/cheatsheet.md | 6 ++++-- .../how_to_serve_another_domain_for_webfinger.md | 3 ++- docs/docs/configuration/i2p.md | 3 ++- 4 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/docs/administration/CLI_tasks/config.md b/docs/docs/administration/CLI_tasks/config.md index 06d612cae..e738baad0 100644 --- a/docs/docs/administration/CLI_tasks/config.md +++ b/docs/docs/administration/CLI_tasks/config.md @@ -179,8 +179,9 @@ it may be easier to dump the values to JSON and then modify them in a text edito ## Loading specific configuration values from JSON -**Note:** This will overwrite any existing value in the database, and can -cause crashes if you do not have exactly the correct formatting. +!!!note + This will overwrite any existing value in the database, and can + cause crashes if you do not have exactly the correct formatting. Once you have modified the JSON file, you can load it back into the database. @@ -200,6 +201,7 @@ Once you have modified the JSON file, you can load it back into the database. mix pleroma.config load_from_file /tmp/mrf_simple.json ``` -**NOTE** an instance reboot is needed for many changes to take effect, -you may want to visit `/api/v1/pleroma/admin/restart` on your instance -to soft-restart the instance. +!!! note + An instance reboot is needed for many changes to take effect, + you may want to visit `/api/v1/pleroma/admin/restart` on your instance + to soft-restart the instance. diff --git a/docs/docs/configuration/cheatsheet.md b/docs/docs/configuration/cheatsheet.md index 7216af86c..425488958 100644 --- a/docs/docs/configuration/cheatsheet.md +++ b/docs/docs/configuration/cheatsheet.md @@ -888,7 +888,8 @@ or curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites" ``` -Warning: it's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead. +!!! warning + It's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead. ### :auth @@ -1127,7 +1128,8 @@ meaning that only authenticated users will be able to access the corresponding r If you'd like to allow unauthenticated access to specific resources, you can turn these settings to `false`. -**Note**: setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline). +!!! note + Setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline). ## Pleroma.Web.ApiSpec.CastAndValidate diff --git a/docs/docs/configuration/how_to_serve_another_domain_for_webfinger.md b/docs/docs/configuration/how_to_serve_another_domain_for_webfinger.md index 417432ab8..6d6df2571 100644 --- a/docs/docs/configuration/how_to_serve_another_domain_for_webfinger.md +++ b/docs/docs/configuration/how_to_serve_another_domain_for_webfinger.md @@ -27,7 +27,8 @@ This file will indeed contain a URL template of the form `https://example.org/.w ## Configuring your Akkoma instance -**_DO NOT ATTEMPT TO CONFIGURE YOUR INSTANCE THIS WAY IF YOU DID NOT UNDERSTAND THE ABOVE_** +!!! danger + DO NOT ATTEMPT TO CONFIGURE YOUR INSTANCE THIS WAY IF YOU DID NOT UNDERSTAND THE ABOVE ### Configuring Akkoma diff --git a/docs/docs/configuration/i2p.md b/docs/docs/configuration/i2p.md index cc4a96858..17dbe62e5 100644 --- a/docs/docs/configuration/i2p.md +++ b/docs/docs/configuration/i2p.md @@ -15,7 +15,8 @@ One using the config, and one using external software (fedproxy). The external s ### Using the Config -**Warning:** So far, everytime I followed this way of federating using I2P, the rest of my federation stopped working. I'm leaving this here in case it will help with making it work. +!!! warning + So far, everytime I followed this way of federating using I2P, the rest of my federation stopped working. I'm leaving this here in case it will help with making it work. Assuming you're running in prod, `cd` to your Akkoma folder and append the following to `config/prod.secret.exs`: ```