From 70f491fd27586016258459297d0419a0ce5da514 Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Sun, 31 Jan 2021 17:50:33 +0000 Subject: [PATCH] Add Editor help page --- app/flatpages/help.md | 4 ++++ app/flatpages/help/editors.md | 34 ++++++++++++++++++++++++++++++++++ docs/README.md | 6 ++++++ 3 files changed, 44 insertions(+) create mode 100644 app/flatpages/help/editors.md create mode 100644 docs/README.md diff --git a/app/flatpages/help.md b/app/flatpages/help.md index 4da4910..5499f83 100644 --- a/app/flatpages/help.md +++ b/app/flatpages/help.md @@ -17,6 +17,10 @@ title: Help * [Creating Releases using Webhooks](release_webhooks) * [Package Configuration and Releases Guide](package_config) +## Help for Specific User Ranks + +* [Editors](editors) + ## APIs * [API](api) diff --git a/app/flatpages/help/editors.md b/app/flatpages/help/editors.md new file mode 100644 index 0000000..f8aa483 --- /dev/null +++ b/app/flatpages/help/editors.md @@ -0,0 +1,34 @@ +title: Editors + +## What should editors do? + +Editors are users of rank Editor or above. +They are responsible for ensuring that the package listings of ContentDB are useful. +For this purpose, they can/will: + +* Review and approve packages. +* Edit any package - including tags, releases, screenshots, and maintainers. +* Create packages on behalf of authors who aren't present. + +Editors should make sure they are familiar with the +[Package Inclusion Policy and Guidance](/policy_and_guidance/). + +## ContentDB is not a curated platform + +It's important to note that ContentDB isn't a curated platform, but it also does have some +requirements on minimum usefulness. See 2.2 in the [Policy and Guidance](/policy_and_guidance/). + +## Editor Work Queue + +The [Editor Work Queue](/todo/) and related pages contain useful information for editors, such as: + +* The package, release, and screenshot approval queues. +* Packages which are outdated or are missing tags. +* A list of forum topics without packages. + Editors can create the packages or "discard" them if they don't think it's worth adding them. + +## Editor Notifications + +Editors currently receive notifications for any new thread opened on a package, so that they +know when a user is asking for help. These notifications are shown separately in the notifications +interface, and can be configured separately in Emails and Notifications. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..00cda9c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,6 @@ +# Docs + +This folder only contains technical documentation for those interested in the ContentDB source code. + +Documentation for using ContentDB, whether through the interface or API, is available at +.