Move digest email docs to a separate file and improve styling
authorrinpatch <rinpatch@sdf.org>
Wed, 2 Oct 2019 22:09:51 +0000 (01:09 +0300)
committerrinpatch <rinpatch@sdf.org>
Wed, 2 Oct 2019 22:10:36 +0000 (01:10 +0300)
docs/administration/CLI_tasks/digest.md [new file with mode: 0644]
docs/administration/CLI_tasks/emoji.md
lib/mix/tasks/pleroma/digest.ex

diff --git a/docs/administration/CLI_tasks/digest.md b/docs/administration/CLI_tasks/digest.md
new file mode 100644 (file)
index 0000000..89b3ed2
--- /dev/null
@@ -0,0 +1,15 @@
+# Managing digest emails
+Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl digest` and in case of source installs it's `mix pleroma.digest`.
+
+## `test`
+
+```sh
+$PREFIX test <nickname> <since_date>
+```
+
+Send digest email since given date (user registration date by default) ignoring user activity status.
+
+Example: 
+```sh
+$PREFIX test donaldtheduck 2019-05-20
+```
index 5b8dc11ab682c67e657423480c6d2a6e43373220..39216a897692fc05972e465d5d11749f4a6abe6d 100644 (file)
@@ -2,7 +2,7 @@
 
 Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl emoji` and in case of source installs it's `mix pleroma.emoji`.
 
-## ls-packs
+## `ls-packs`
 
 ```sh
 $PREFIX ls-packs [OPTION...]
@@ -13,7 +13,7 @@ Lists the emoji packs and metadata specified in the manifest.
 ### Options
 - `-m, --manifest PATH/URL` - path to a custom manifest, it can either be an URL starting with `http`, in that case the manifest will be fetched from that address, or a local path
 
-## get-packs
+## `get-packs`
 ```sh
 $PREFIX get-packs [OPTION...] PACKS
 ```
@@ -22,7 +22,7 @@ Fetches, verifies and installs the specified PACKS from the manifest into the `S
 ### Options
 - `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)
 
-## gen-pack
+## `gen-pack`
 ```sh
 $PREFIX gen-pack PACK-URL
 ```
index 430116a505e4db3229ea0457f01d97f03c07529e..100a81060c88f8c426cecff2af90ed6ba4bd2843 100644 (file)
@@ -2,16 +2,7 @@ defmodule Mix.Tasks.Pleroma.Digest do
   use Mix.Task
 
   @shortdoc "Manages digest emails"
-  @moduledoc """
-  Manages digest emails
 
-  ## Send digest email since given date (user registration date by default)
-  ignoring user activity status.
-
-  ``mix pleroma.digest test <nickname> <since_date>``
-
-  Example: ``mix pleroma.digest test donaldtheduck 2019-05-20``
-  """
   def run(["test", nickname | opts]) do
     Mix.Pleroma.start_pleroma()