diff options
| -rw-r--r-- | index.md | 17 | ||||
| -rw-r--r-- | installation.md | 5 | ||||
| -rw-r--r-- | lists.sr.ht/index.md | 59 | ||||
| -rw-r--r-- | sr.ht/index.md | 25 |
4 files changed, 100 insertions, 6 deletions
@@ -3,9 +3,14 @@ You can access each of our main tools from the navigation above. You're currently on man.sr.ht, which is the documentation hub for sr.ht and many of the projects hosted here. -If you're new here, you'll probably want to tweak your account settings at <a -href="https://meta.sr.ht">meta.sr.ht</a> and perhaps create some git -repositories on <a href="https://git.sr.ht">git.sr.ht</a>. +If you're new here, you'll probably want to tweak your account settings at +<a href="https://meta.sr.ht">meta.sr.ht</a> and perhaps create some git +repositories on <a href="https://git.sr.ht">git.sr.ht</a>. You probably also +want to subscribe to the <a +href="https://lists.sr.ht/~sircmpwn/sr.ht-announce">sr.ht-announce</a> mailing +list, a low-volume list of new features and announcements. + +For general sr.ht help, consult the [General Documentation](/sr.ht). **NOTE**: This documentation is a work in progress, and is incomplete in many places. @@ -32,6 +37,12 @@ places. </dd> </div> <div class="col-md-6"> + <dt><a href="https://lists.sr.ht">lists.sr.ht</a></dt> + <dd> + <a href="/lists.sr.ht">User Manual</a> + </dd> + </div> + <div class="col-md-6"> <dt><a href="https://meta.sr.ht">meta.sr.ht</a></dt> <dd> <a href="/meta.sr.ht">User Manual</a>—<a href="#">API Reference</a> diff --git a/installation.md b/installation.md index 93eec18..189a40d 100644 --- a/installation.md +++ b/installation.md @@ -8,6 +8,11 @@ installation page: - [meta.sr.ht](/meta.sr.ht/installation.md) - [todo.sr.ht](/todo.sr.ht/installation.md) +All sr.ht sysadmins are encouraged to subscribe to the +[sr.ht-admin](https://lists.sr.ht/~sircmpwn/sr.ht-admin) mailing list, a +low-volume list of sysadmin-oriented announcements regarding breaking changes, +security vulnerabilities, and so on. + General installation instructions follow. # Packages diff --git a/lists.sr.ht/index.md b/lists.sr.ht/index.md new file mode 100644 index 0000000..e41571f --- /dev/null +++ b/lists.sr.ht/index.md @@ -0,0 +1,59 @@ +[lists.sr.ht](https://lists.sr.ht) is the sr.ht mailing list service. + +# Email controls + +You may subscribe to any list by emailing +`user/list-name+subscribe@lists.sr.ht`. You may unsubscribe with `+unsubscribe`. +You may post new threads to this list by writing to the address with no `+` +command. + +# Dashboard + +Your [dashboard](https://lists.sr.ht) shows you recent emails on mailing lists +you're subscribed to. You can reply to one by clicking the author's name, or +view the thread by clicking the subject. + +# Profile + +Your public profile page shows a feed of emails authored by you, as well as a +list of mailing lists you administrate. Like the dashboard, emails can be +replied to by clicking the authors name and you can view the thread by clicking +the subject. + +# Archive + +Each list shows a list of archives, sorted by which has seen the most recent +activity. In each thread's heading, you can see the number of participants, +number of replies, and subject of the initial message. Click the subject to see +the full thread. + +# Threads + +Email threads can become trees as participants reply to different messages. In +the simple case of a linear thread, you will see replies written linearly. +However, if a thread becomes split, you may see several linear trees of +discussion form. + +To reply to a message, click the author's name. + +# List Administration + +List access controls are available on your list settings, which can be accessed +with the "List settings" button on the list archive. The controls are +fine-grained enough to support many access scenarios, here are some examples: + +## Announcement lists + +A list that only you can write to is useful for announcements. Remove all user's +"post" and "reply" permissions to prevent them from submitting - owners are +always able to post. You can optionally leave the "reply" permission enabled to +allow people to respond to announcements, but be aware that their responses will +be sent out to all subscribers, which is usually undesirable for low-volume +announcement lists. + +## Write-only security lists + +If you want a mailing list where people can write to you about security +vulnerabilities in your software, you can remove the "browse" permission without +removing the "post" or "reply" permissions from the list. This will allow people +to send emails to the list, but not view the archives or subscribe. diff --git a/sr.ht/index.md b/sr.ht/index.md index feec7ec..bfe5877 100644 --- a/sr.ht/index.md +++ b/sr.ht/index.md @@ -16,11 +16,30 @@ which you are unsure of the appropriate tracker: - [sr.ht](https://todo.sr.ht/~sircmpwn/sr.ht) +# Getting help + +sr.ht questions, feature requests, and general discussion are held on the +~sircmpwn/sr.ht-discuss mailing list: + +https://lists.sr.ht/~sircmpwn/sr.ht-discuss + +Please search the archives for threads related to your question before posting. + # Development -If you would like to participate in sr.ht's development, please email patches to -[sir@cmpwn.com](mailto:sir@cmpwn.com). Collaboration is done on IRC at [#cmpwn -on Freenode](http://webchat.freenode.net/?channels=%23cmpwn&uio=d4). +sr.ht development takes place on the +[sr.ht-dev](https://lists.sr.ht/~sircmpwn/sr.ht-dev) mailing list. Please email +patches and development-related questions there. Source code for sr.ht is available on [~sircmpwn's git.sr.ht account](https://git.sr.ht/~sircmpwn/?search=sr.ht). + +# IRC + +An IRC channel is also available for sr.ht-related discussion: [#cmpwn +on Freenode](http://webchat.freenode.net/?channels=%23cmpwn&uio=d4). + +# Security vulnerabilities? + +Please send an email to [sir@cmpwn.com](mailto:sir@cmpwn.com), optionally using +the public key [7BC79407090047CA](https://drewdevault.com/publickey.txt). |