murmeldin/plenum-bot
1
1
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

reword config descriptions

Browse source
This commit is contained in:
nobody 2024-08-05 01:53:01 +02:00 committed by murmeldin
parent 427bd27968
commit 155bab8e5e
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/config_check.rs
View file

@ -28,7 +28,7 @@ const CONFIG_SPEC: CfgSpec<'static> = CfgSpec {
CfgField::Default { key: "template-name", default: "plenum-template", description: "Name of the pad containing the template to use." }, CfgField::Default { key: "template-name", default: "plenum-template", description: "Name of the pad containing the template to use." },
// TODO: make these generators? // TODO: make these generators?
CfgField::Optional { key: "last-id", description: "ID of last plenum's pad." }, CfgField::Optional { key: "last-id", description: "ID of last plenum's pad." },
CfgField::Optional { key: "next-id", description: "ID of next plenum's pad." } CfgField::Optional { key: "next-id", description: "ID of next plenum's pad." },
], ],
}, },
CfgGroup { name: "email", CfgGroup { name: "email",
@ -39,17 +39,17 @@ const CONFIG_SPEC: CfgSpec<'static> = CfgSpec {
CfgField::Password { key: "password", description: "Password for authenticating with the mail server." }, CfgField::Password { key: "password", description: "Password for authenticating with the mail server." },
CfgField::Default { key: "sender", default: "Plenumsbot <plenum-bot@berlin.ccc.de>", description: "Email address to use for \"From:\"." }, CfgField::Default { key: "sender", default: "Plenumsbot <plenum-bot@berlin.ccc.de>", description: "Email address to use for \"From:\"." },
CfgField::Default { key: "to", default: "CCCB Intern <intern@berlin.ccc.de>", description: "Recipient of the emails sent." }, CfgField::Default { key: "to", default: "CCCB Intern <intern@berlin.ccc.de>", description: "Recipient of the emails sent." },
CfgField::Optional { key: "last-message-id", description: "Message-Id of last initial announcement to send In-Reply-To (if applicable)." } CfgField::Optional { key: "last-message-id", description: "Message-Id of last initial announcement to send In-Reply-To (if applicable)." },
], ],
}, },
CfgGroup { name: "wiki", CfgGroup { name: "wiki",
description: "API Settings for Mediawiki", description: "API Settings for Mediawiki",
fields: &[ fields: &[
CfgField::Default { key: "http-user", default: "cccb-wiki", description: "Username that would be needed if you would access the wiki with your web browser" }, CfgField::Default { key: "server-url", default: "https://wiki.berlin.ccc.de/" , description: "Server running the wiki." },
CfgField::Password { key: "http-pass", description: "Password that would be needed if you would access the wiki with your web browser" }, CfgField::Default { key: "http-user", default: "cccb-wiki", description: "HTTP basic auth user name." },
CfgField::Default { key: "api-user", default: "PlenumBot@PlenumBot-PW1", description: "API Username that was generated in the mediawiki by the PlenumBot-Account" }, CfgField::Password { key: "http-pass", description: "HTTP basic auth password." },
CfgField::Password { key: "api-secret", description: "API Secret that was generated in the mediawiki by the PlenumBot-Account. Example: \"PlenumBot-PW1@mgeg89bgit09q8bjblt5tn5ojj2d4gy\"" }, CfgField::Default { key: "api-user", default: "PlenumBot@PlenumBot-PW1", description: "API Username associated with the bot account used for edits." },
CfgField::Default { key: "server-url", default: "https://wiki.berlin.ccc.de/" , description: "Link that is needed for getting the session token" } CfgField::Password { key: "api-secret", description: "API secret / \"password\" used for authenticating as the bot." },
], ],
}, },
// TODO: Matrix, // TODO: Matrix,