forked from AkkomaGang/akkoma
Move digest email docs to a separate file and improve styling
This commit is contained in:
parent
bd9c7807fb
commit
869ea2ab90
3 changed files with 18 additions and 12 deletions
15
docs/administration/CLI_tasks/digest.md
Normal file
15
docs/administration/CLI_tasks/digest.md
Normal file
|
@ -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
|
||||
```
|
|
@ -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
|
||||
```
|
||||
|
|
|
@ -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()
|
||||
|
||||
|
|
Loading…
Reference in a new issue