<!DOCTYPE html>
<html>
<head>
<title></title>
<style type="text/css">p.MsoNormal,p.MsoNoSpacing{margin:0}</style>
</head>
<body><div>Summary of feedback from the Write the Docs doc sprint last Friday.<br></div>
<div><a href="http://www.writethedocs.org/conf/au/2017/">http://www.writethedocs.org/conf/au/2017/</a><br></div>
<div><br></div>
<div>As mentioned, I had two users I was talking with. One is a technical writer and used to dealing with subject-specific terminology but had no experience with mail systems. The other is an engineer who currently runs Dovecot for a side project and thinks he might have used Cyrus in the past.<br></div>
<div><br></div>
<div><b>Front page</b><br></div>
<div>Wall of text and acronyms. Intimidating.</div>
<div><br></div>
<ul><li>Pull in content from the github readme that explains in simpler language what Cyrus is<br></li><li>Some images to break up the text and reinforce that Cyrus supports not just mail, but calendaring and contacts on mobile too.<br></li><li>Showcase places that Cyrus is being used. (If you're happy for your organization name to appear in the docs, please let me know! Optional: send me a logo and a link) This helps distinguish Cyrus as mail software, not a mail hosting service.<br></li><li>If there's anyone who does professional services support for Cyrus, make sure they're listed. (anyone? anyone?)<br></li><li>Explain target profile. "You want to run Cyrus if you want these features, and you have this many mailboxes/users and you know what you're doing with running/supporting a mail system. You do not want to run Cyrus if: ..."</li></ul><div><br></div>
<div><b>Navigation</b><br></div>
<div>The top navigation bar confused users. They were expecting dropdown sub menu, but then there's also the left menu.</div>
<ul><li>The top menu bar no longer needs to be there. It's a hangover from when the left hand menu bar was a maze of twisty passages all alike and I wanted a way to quickly help users find common entry points.<br></li></ul><div>The search box was overlooked.<br></div>
<ul><li>I might make this bigger and/or put it in the top menu bar as the only thing.<br></li></ul><div>Confused by left hand menu ordering.<br></div>
<ul><li>They both expected the Overview to come first, followed by Quickstart, then Download, then Setup.</li><li>They did like the categorization of the top level menu hierarchy. Easy to drill down one level.<br></li><li>Second level and beyond menu items were intimidating in many places. Again, technical overwhelm.</li></ul><div><br></div>
<div><b>Content</b><br></div>
<ul><li>Cyrus is not a complete solution on its own: you need other system components (MTA: sendmail/postfix/exim/..., possibly webmail interface).<br></li><li>Both users went looking for system requirements and couldn't find a succinct list. I'll need to write this. (including content from the above point)<br></li><li>They wanted to know if it could be run on vmware (or equivalent) or cloud hosted.</li><li>Overview was deemed too technical. <br></li><ul><li>The Overview/Features section was just okay<br></li><li>The Overview/Concepts section was more of a reference manual than an explanation of ideas: need to review and split this apart.<br></li></ul></ul><div><br></div>
<div>The documentation has plenty of ways to evolve! If anyone is interested in helping out, do let me know.<br></div>
<div><br></div>
<div>And if you know of anyone who<br></div>
<ul><li>does professional Cyrus support, or<br></li><li>uses Cyrus and is happy to have that listed on our site<br></li></ul><div>drop me a line and I'll put you in.<br></div>
<div><br></div>
<div>Cheers,<br></div>
<div><br></div>
<div> Nicola</div>
<div><br></div>
<div>On Mon, Nov 27, 2017, at 10:26 PM, Bron Gondwana wrote:<br></div>
<blockquote type="cite"><div style="font-family:Arial;">Present: Bron, Ken, Nicola, ellie<br></div>
<div style="font-family:Arial;"><br></div>
<div style="font-family:Arial;">Bron:<br></div>
<div style="font-family:Arial;">* Lots of Xapian issues last week<br></div>
<div style="font-family:Arial;">* including seqset bug<br></div>
<div style="font-family:Arial;">* incorrect UID issue for per-user-data only updates with calendar events.<br></div>
<div style="font-family:Arial;">* index_snippets is keeping the mailbox locked while reading from disk and generating snippets, which can be slow and block out other actions. We should find a solution to this.<br></div>
<div style="font-family:Arial;"><br></div>
<div style="font-family:Arial;"><div>Ken:<br></div>
<div>* working on docs for internals changes - sync, rename safety etc<br></div>
</div>
<div style="font-family:Arial;">* SASL - looks like Alexey is correct, and people were relying on buggy behaviour<br></div>
<div style="font-family:Arial;">* found a logic error with Bearer Token authentication.<br></div>
<div style="font-family:Arial;">* short week this week<br></div>
<div style="font-family:Arial;"><br></div>
<div style="font-family:Arial;">Nicola:<br></div>
<div style="font-family:Arial;">* went to write-the-docs on Friday, single day conference<br></div>
<div style="font-family:Arial;">* didn't fix any doc bugs<br></div>
<div style="font-family:Arial;">* had people with mail server knowledge<br></div>
<div style="font-family:Arial;"> - used them as guinea-pigs to look at our existing docs<br></div>
<div style="font-family:Arial;"> - have notes which will write up and send to list<br></div>
<div style="font-family:Arial;"> - if you don't already know what Cyrus is and how it works, it's a wall of acronyms<br></div>
<div style="font-family:Arial;"> - FastMail webpage was the kind of thing he was expecting - but at least Cyrus docs look better than Dovecot!<br></div>
<div style="font-family:Arial;">* FastMail caldav sync doesn't handle alarms particularly nicely.<br></div>
<div style="font-family:Arial;">* Also, FastMail caldav sync should be copy through calendar-user-address from the source and passing that through for clients to use for scheduling.<br></div>
<div style="font-family:Arial;"><br></div>
<div style="font-family:Arial;">ellie:<br></div>
<div style="font-family:Arial;">* just been looking into the jmap getmessagelist stuff -- that email thread today is v useful<br></div>
<div style="font-family:Arial;"><br></div>
<div style="font-family:Arial;">sasl is just a point release, so should be safe to upgrade independently<br></div>
<div style="font-family:Arial;"><br></div>
<div style="font-family:Arial;">Partha is back working on zeroskip after being involved in the xapian fixes most of last week.<br></div>
<div style="font-family:Arial;"><br></div>
<div><div>--<br></div>
<div> Bron Gondwana, CEO, FastMail Pty Ltd<br></div>
<div> brong@fastmailteam.com<br></div>
<div><br></div>
</div>
<div style="font-family:Arial;"><br></div>
</blockquote><div><br></div>
</body>
</html>