Hi folks,
I'm a tech writer with FastMail and I'm here to help.
Here's my plan to organise the (many and flavourful) varieties of
documentation surrounding the Cyrus imap universe. Please speak up if
you have thoughts/ideas/objections!
*The Goal* Make the content on docs.cyrus.foundation the aut
but whatever is used, we
should unify this
> * For the record, this does not appear to make a significant
difference in HTML output, but does affect man page
rendering (at least in my experience).
> Okay, I'll get off of my soapbox for now. I just wa
Hi all,
I'm trying to generate the docs using Sphinx so I can properly verify my
output.
Generation is falling over itself with errors. Warnings about missing
files and dodgy directives before it finally dies with an exception.
Does it work for anyone else? (Nic, Jeroen: I'm looking at you two!)
Don't recall what I needed to
> install to get it working, but now I just run "make html" in the
> cyrus-docs directory and it does its thing.
>
> Cheers,
>
> ellie
>
> On Thu, May 21, 2015, at 02:56 PM, Nicola Nye wrote:
> > Hi all,
> >
>
Hi Conrad (and anyone else with a development install),
With Ellie away, you're now my expert (!) on getting a developer
environment up and running. I'm looking at freshening the docs on our
official docs.cyrus.foundation site.
I know you have followed Ellie's install notes which have been
summar
Hi Nic
Nice sleuthing work!
The only alternative I have to offer is that much as Sphinx allows you
to write custom themes to change the look and feel of the html, you can
also write your own builder (or extend an existing one).
http://sphinx-doc.org/extdev/index.html#dev-extensions
That would le
Hi Nic,
I'm not a Python person either by any means, but to my untrained eye
your updates look good.
For what it's worth, Bron and I were discussing whether we should look
at
migrating the website from Sphinx to some wiki variant in order to make
it
easier for contributors to add to the documenta
Gday all,
Jeroen, are you able to update the Harbormaster build environment?
The docs build is currently broken because the version of Sphinx and
docutils are significantly old. Nic and I have both been building
against a newer set of tools.
Can we get them brought up to the following versions:
Nic, I think the build is in your camp.
Log shows: *** No rule to make target `tools/config2rst', needed by
`doc/rst/imapd.conf.rst'. Stop.
Thanks Jeroen for updating the build environment for us!
On Wed, Jul 1, 2015, at 07:39 PM, Jeroen van Meeuwen (Kolab Systems)
wrote:
> On 2015-06-30 01:11
I've updated the developer install guide to reflect this discussion,
in case anyone else runs into the same warnings and isn't sure how
to proceed.
On Tue, Jul 14, 2015, at 10:52 PM, Ken Murchison wrote:
> It suggests v2.0, but it isn't required
if you don't need/want RSCALE, VPOLL, or VAVA
G'day,
I was just checking through our fabulous server basic setup guide
(thoughtfully written by Conrad) and noted that he had a few issues
making some changes persistent. Are these normal (surely not) or a
peculiarity of his system or a symptom of some extra config that's
missing? (Could there b
Hi Cyrus,
I'm currently working on some basic architecture diagrams that will
complement the documentation to show the moving parts. Today's topic:
replication.
Based on a delightfully drawn whiteboard session with Bron, I am left
with a couple of queries:
Do we have multiple sync_clients becaus
G'day,
Nic B and Jeroen, I think this is mostly something you'll have some
thoughts about...
Currently the rst docs make use of a :manpage: tag. This does little
more than change the formatting of the affected text.
For the html docs, it makes far more sense for it to convert it to the
link for
o it's not
an entirely undefined job)
https://git.cyrus.foundation/T213
Nicola
On Thu, Aug 6, 2015, at 11:21 AM, Nicola Nye wrote:
> G'day,
>
> Nic B and Jeroen, I think this is mostly something you'll have some
> thoughts about...
>
> Currently the rst
I've nearly incorporated all of the information you fine folks have
provided, at least as far as common usage scenarios go, into the docs.
One final gap remains in my knowledge...
I have the impression that a replica can be set up to have a subset of
all the users/mailboxes of a master. Have I mi
o a mass search/replace operation with
(poorly written, most likely, pseudo-code):
>
>> /manpage:`(\S)(\(\S\))`/manpage:`$1`*$2*/
>>
> That, I think, would do what we wish. We'd have to decide which
modifier rendered most properly for the parenthetical part, in bot
it uses the new tag...
On Fri, Aug 7, 2015, at 03:03 PM, Nicola Nye wrote:
> Hi Nic,
>
> I like your thinking, but as you've noted, it doesn't really handle
> what we after.
>
> We need something which can interrogate the (8) vs (5) and interpret
> that in the
't want to :cyrusman:ls for instance)
Let me know if this works any better for you!
On Fri, Aug 14, 2015, at 01:00 AM, Nic Bernstein wrote:
> On 08/13/2015 12:15 AM, Nicola Nye wrote:
>
>> Delicious victory is mine!
>>
>> We now have a :cyrusman: sphinx optio
k whatever check your cyrusman 'role' is performing has a
problem.
>
>
It's too late in the evening, being 3-scotch o'clock, for me to
diagnose this from this side of the world. ;-0
>
-nic
>
>
> On 08/13/2015 09:25 PM, Nicola Nye
wrote:
>&g
More I would say that the git version is the one which is obsolete. It
should already contain those extra cpan items.
On Mon, Aug 17, 2015, at 02:21 PM, Chris Davies wrote:
> Should we remove
> https://docs.cyrus.foundation/imap/developer/installguide.html if it's a
> duplicate of
> https://git.cy
Hi Nic,
Your edits make sense. Go ahead and land them. Thanks for the extra
information!
Third person. That is definitely the goal for the reference docs, though
I did stick deliberately with the second person for the install guides.
Terms: tldr - let's use "frontend" and "backend".
>From the p
On Fri, Aug 21, 2015, at 11:35 AM, Bron Gondwana wrote:
>
>
> Murder plus replication is a giant ball of suck right now. They don't
> know about each other, and they interact badly :(
>
So is that a case for documenting "Here be dragons, enter at your own
risk" for the moment?
Does it mean that
Hi Nic,
Would love it if you wanted to write up murderous replication.
And hey, failover too, in the non-murdery/murdery replication scenarios.
I'm sure there's more than one way to implement it, but it would be
great to have a starting point in the docs.
On Fri, Aug 21, 2015, at 12:26 PM, Nic
Hi Ellie et al.,
Did you guys discuss this at the most recent Cyrus hangout at all?
Regarding the docs: I think what I might do is create the structure on
docs.cyrus.foundation to match cyrusimap.org and put links back to
cyrusimap where I haven't yet transferred the content.
That way we can use
Hi gang,
In the last stages of bringing over the wiki from cyrusimap.org onto
docs.cyrus.foundation. Nearly there!
Looking at the Future Ideas page:
http://www.cyrusimap.org/mediawiki/index.php/Future_Ideas
I suspect that many of these future ideas are now past ideas, having
been implemented or
Dear Cyrus folks,
After nominally completing the migration of the docs from the wiki at
cyrusimap.org onto the sphinx repository at docs.cyrus.foundation, I
worked out there was a whole bunch of existing services at cyrusimap.org
that were non-trivial to relocate. Which, after some discussion at t
Hi all,
Per the last discussion, let's make the migration happen.
*) Move everything onto cyrusimap.org
*) Retain Sphinx for docs
*) Rejoice
Here's the plan of action so everyone knows what's coming...
1) Install Sphinx v1.2.3 on cyrusimap.org
2) Configure Sphinx to auto-build on new pushes
Hi all,
I've been cleaning up the docs and I think I can remove a Tools and
Utilities page
(https://docs.cyrus.foundation/imap/admin/administration-tools.html)
because Nic (onlight) has properly written up all the content elsewhere.
However I wanted to check before hit the big red delete button,
do these stand?
compile_st.pl
fixsearchpath.pl
Nicola
On Fri, Oct 23, 2015, at 02:45 PM, Bron Gondwana wrote:
>
>
> On Fri, Oct 23, 2015, at 13:11, Nicola Nye wrote:
> > Hi all,
> >
> > I've been cleaning up the docs and I think I can remove a Tools and
> > Utiliti
With Cyrus 3.0.0 now released into the wild, we'd like to have you join
us for a *Documentation Hackathon!*
https://github.com/cyrusimap/cyrus-imapd/wiki/Docathon
*When*: Monday April 3 - Friday April 14
(We welcome documentation contributions at all times, but the core team
is aiming for a c
Hi all!
Here in the land of Cyrus docs, we've been working hard on making the
world a better place... through email.
Here's what we've done so far:
* Updated the sample cyrus.conf files so they're actually current and
placed them inside the doc tree, ensuring they'll be packaged and
t
Here are the minutes:
Ken:
* Sieve ihave extension is finished and live in master!
* Going to start looking at saving a copy of outgoing messages sent via
sieve (such as vacation messages etc)
Robert:
* message annotations work continues
* There's a problem with the base thread id annota
We've cancelled the meeting for this coming Monday as too many core
contributors aren't able to make the meeting.
So the next meeting will be
*Monday April 24th at 12pm UTC*
Note: time has shifted **one hour later.**
On Mon, Apr 10, 2017, at 09:25 PM, Nicola Nye wrote:
>
Hi all,
I'm sure someone knows the answer to Nikki's question about memory
usage on 2.4.
Is 2.5 more reliable or should they go to 3.0?
Cheers,
Nicola
- Original message -
From: momoren <962747...@qq.com>
To: nicolan
Subject: Imapd unusual memory usage
Date: Mon, 17
件人:* "Дилян Палаузов";;
*发送时间:* 2017年4月17日(星期一) 晚上6:37
*收件人:* "Nicola Nye";
*抄送:* "momoren"<962747...@qq.com>;
*主题:* Re: Fwd: Imapd unusual memory usage
Hello,
compile cyrus with debug information, and run it under valgrind:
valgrind --num-callers=30 --leak-ch
These lovely folks showed up: Bron, Ken, Robert, Ellie, Nic, Nicola
Among other things, we talked about:
* JMAP and unicode. (Roberrt)
* Fixing replication of basethrid (Bron)
* Release of 3.0.1 last week (Ellie)
* Enhancements to stat counting/reporting. prometheus.io vs refactoring
snmp
Hi all!
No Cyrus meeting today: a few of our key contributors are absent.
We'll be back at it next week, June 12th at noon UTC
hangouts.google.com/hangouts/_/g4xnqjjb5zvomzeb4kqvja3fz4aWe welcome lurkers,
peanut gallery, contributors past, present and
future. Come say hi!
And a big shout out to
Cyrus team met once again, same bat time, same bat channel.
Here's what we've been working on!
Ken-
Shared alarms: splitting them out on the fly rather than doing
them in bulk What do we do if something gets unshared.
- Check ACL at alarm time and not re-send, not re-schedule.
- Ow
*Who came: *Bron, Ellie, Ken, Robert, Nicola, Partha
*What we spoke about:*
Bron
* Just returning back from IETF in Prague (exchanging Aussie winter for
European summer)
* JMAP session went very well, with agreement on message submission and
managing request list.
* Sticking points are not u
Hi!
As a doc maintainer on the Cyrus project I read the responses coming in to the
upgrade survey, which is linked to at the bottom of the 3.0 upgrade
instructions.
*If you have problems with your upgrade,* and you want help, *please follow up
with a post to the mailing list! *
The survey respo
Attendees: Partha, Ken, Nicola, Bron
* Partha has been shadowing Ellie so he can do release management while
she's on leave.
* Lots of knowledge sharing around the team coming up so we have fewer
silos of knowledge: RobertS, Ken, Partha, Bron.
* Dicerolls continue to be successful, as a bunch
Hi all!
Sorry for the late notice, but today's meeting is cancelled.
Ken is in a plane, and Bron has just gotten off an plane and has no idea
what time it is: we will be missing enough of the core team to call off
the meeting for today.
We do look forward to chatting with you all next week!
N
Who came:
Bron, Ken, Partha, RobertS, ellie, Nicola
Cyrus.works (the continuous integration environment) is now passing with
all tests!Thanks to Robert S with his work debugging timezone library madness.
IETF:
Jmap discussions later this week at IETF
Ken working on RFC drafts he owes up
Summary of feedback from the Write the Docs doc sprint last Friday.
http://www.writethedocs.org/conf/au/2017/
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
Present: Ken, Partha, Robert, Ellie, Nicola
Next meeting Monday Dec 18th will be the last one for 2017.
First meeting in 2018 will be January 8th.
Zeroskip: Partha
* Setting up timing comparison to twoskip
* working on compaction: aiming to be complete this week
* next: merging of databases
*
That was a nice bug!
In the event of a failover, is there human intervention required to
adjust sync mode so the old replica/new master now knows it's the boss?
Tell me about your documentation plans!
On Thu, Dec 28, 2017, at 3:02 PM, Bron Gondwana wrote:
> Calendar alarms and replication are a
Always wanted to join in the Cyrus meetings but the time was
inconvenient/awkward/when you were sleeping?
Next week's meeting is at a different time!
Monday 9pm UTC
Monday 1pm PST
Monday 4pm EST
Monday 10pm Vienna
Tuesday 8am Melbourne
We'd love to see you there. Let's talk about packaging for
What a great meeting: a new face came along, and some older friends
we haven't seen in a while because timezones and work commitments get
in the way.
Attendees: Jan, Ellie, Bron, Robert, Ken, Michael, Nicola, Ricardo, Nic B
Next meeting: we're keeping the new time for a while as it's kinder to
our
Present: Partha, Ellie, Robert (rsto), Nic (onlight), Nicola, Jason (tibbs),
Simon, Bron
So great chatting (text/voice) to everyone on the call and watching
momentum build as we work towards a compliant jmap implementation and
making life easier for future administrators.
Next meeting: same time n
Hi all!
We failed to take minutes this week (bugfixes, jmap progress, jenkins
builds discussed), but the most important thing is that *next week's
meeting is back at its old time* for a few weeks.
Monday 10pm Australia
Monday UTC 11am
Monday EDT 7am
Monday PDT 4am (sorry!)
We'd love to have you t
i have a sneaking suspicion that USA just did a daylight savings switch.
What time does this make our meeting tonight? (Bearing in mind that it's
also a public holiday here in Melbourne and I'm not sure how many of the
FastMail folks are away)
On Thu, Oct 8, 2015, at 09:20 PM, Bron Gondwana wr
What are the new option controls and where do they live, so I can
do the documentation magic?
On Mon, Nov 16, 2015, at 11:00 PM, Bron Gondwana via Cyrus-devel wrote:
> So this is what I've been working on for the past little bit, on and off
> - mostly in the last week - but I've been building the
points.
Cheers,
Nicola
On Mon, Dec 28, 2015, at 01:45 AM, Patrick Goetz via Cyrus-devel wrote:
> Was this issue ever resolved? I'm still finding the documentation split
> between cyrus.foundation and cyrusimap.org, and it's incomplete in both
> places.
>
> On
gt; popular? Because they took the time to write good documentation. In
> fact, if you want to use an MVC python web framework, the trick is to
> read the Django documentation first, and then use something like
> bottle.py or flask for your web app. Most developers don't bother
Howdy,
I've been trying to beat the cyrus docs menu hierarchy into shape to
make it easier for people to find what they're up to.
First step was building a navigable hierarchy, which is now done.
https://cyrusimap.org/new/
Over the next week I'm going to review the actual content and look at
sh
Present: Nicola, ellie, Simon
Nicola
- New sphinx based doc tree is now live on cyrusimap.org.
- New theme works well on mobile browsers too.
- Old mediawiki site is still present for any existing bookmarks.
- Next task: look at integrating the docs repo into the source repo so
that we can singl
AFAIK, cyrus-sasl has its own tree for library distribution, which
includes its internal documentation such as saslauthd.8 (This is
generated out of saslauthd.mdoc via a "make install" target).
I haven't even looked at cyrus-sasl from a documentation perspective.
(There's a separate mailing list f
t; But the really fiddly thing here is always going to be the fact that we
> need to build most of the man pages from rst files, but we need to build
> some of them (and thus their corresponding web pages...) from imapd
> source files. Taken broadly, i.e. treating "man pages" as
Hi Raymond,
The next meeting is at 11am UTC/10am AEDT Monday Feb 29th. (In other
words: in a few hours from now)
https://plus.google.com/hangouts/_/g4xnqjjb5zvomzeb4kqvja3fz4a
Looking forward to hearing your news.
Nicola
On Wed, Feb 24, 2016, at 01:39 AM, Raymond Poitras via Cyrus-devel wrote:
;
> Thanks for the invitation,
> Unfortunately it was too short notice, and I missed it.
>
> When is the next one?
>
> Thanks
> Raymond
>
>
> 2016-02-28 22:17 GMT-05:00 Nicola Nye via Cyrus-devel <
> cyrus-devel@lists.andrew.cmu.edu>:
>
> > Hi
Hi Robert,
Given a couple of the recent questions on the list about Cyrus and JMAP
support, I think it'd be good to have a quick guide in the docs for
people wanting to get started with it.
We can then also keep it updated with the state of implementation(such
as you've outlined below) which will
a mail
with any corrections.
It's in the repo at cyrus-imapd/doc/source/imap/developer/jmap.rst
Online at cyrusimap.org/imap/developer/jmap.html (or will be in 30
minutes when the next doc rebuild goes through)
Cheers,
Nicola
- Original message -----
From: "Nicola Nye via Cyru
I've been beating on the man pages, trying to reduce duplication so we
can have the One True Source of all things man pagey.
https://git.cyrus.foundation/T236
*Complete*
*
* RST directories split into usercommands (sec1) and systemcommands
(sec8) and files moved to the right spot.
* :cyru
Hi folks,
The man pages in cyrus-imapd/man will be going away Real Soon Now(tm).
So please don't make any further updates to them (or if you do, make the
same change in the .rst file)
Instead, we'll be generating man pages out of the restructured text
files in cyrus-imapd/doc/source/imap/. In
G'day,
I'm trying to flesh out our man pages and corresponding html reference
files for all the programs and tooling that is shipped with Cyrus.
Is anyone able to shed some insight as to what the following tools do
and why you'd use them:
lmtpproxyd, message_test, pop3proxyd, search_test, squ
Thanks for this feedback! I've updated the docs to reflect it.
Please let us know if you notice anything else.
Nicola
- Original message -
From: "qyb via Cyrus-devel"
To: cyrus-devel@lists.andrew.cmu.edu
Subject: Re: v3.0
Date: Fri, 20 May 2016 00:01:08 +0800
website doc error: h
Hi all,
With input from regular contributors, the roadmap online has recently
been updated (for the first time in many a year, I suspect).
http://cyrusimap.org/overview/cyrus_roadmap.html
This covers off the main feature points we are hoping to accomplish for
the next major release:
* JMAP,
*
Ken,
I'm converting the cyrus-sasl docs to sphinx/rst format so we can make
them visible online at cyrusimap.org.
Something which jumped out at me today was the list of supported RFCs.
Several of the drafts listed have subsequently become full fledged RFCs
of their own. Can you eyeball and let me
Hi all,
Today's Cyrus developer meeting at 11am UTC has been cancelled due to
regular maintainers not being available.
Check in same bat time, same bat place next week though!
Cheers,
Nicola
Hi Nic,
For what it's worth, most of the really earlier Maniphest tasks were
mostly about 'finish documenting this thing'.
Oh, here we are, out of my archive of email. T16 was titled "T16: Cyrus
IMAP 2.5 frontends and UID MOVE support on 2.4 backends"
Jeroen made a related commit into phabrica
Hi Nic,
> Hey, on a related note, I've just noticed that
> "cyrus-imapd/doc/legacy/install-
> upgrade.html" is not up on cyrusimap.org and there doesn't appear to
> be any equivalent. Is there a plan for this?
I'm still bringing it all over into Sphinx. When the legacy docs are
imported into
71 matches
Mail list logo
