Thank you, Raphaël.
That gives me a good sense of what needs to be done about the documentation. One question: if these projects (Mime4j, JSieve, JSPF, JDKIM) are stable, and since they seem to be in use for quite some time, what do you think of promoting them to v1.0.0? According to semantic versioning, keeping the version < 1 implies that it is still in beta. Something in beta that is never updated usually ought to be killed. :-) Since that is not the case here, it may be good to promote it. What do you think? Cheers, =David > On May 14, 2020, at 18:57, Raphaël Ouazana-Sustowski <[email protected]> > wrote: > > Hi David, > > Quick answer: most of these projects (Mime4j, JSieve, JSPF, JDKIM) are > libraries that are implementing a specific protocol / RFC. > > They are not meant to change much because these protocols don't neither. > > But they are still interesting because they could be useful for other people > needing these protocols in their products. > > These 4 projects should be documented only in a developper-oriented > documentation, as they have no use for an admin nor a user of a mail server. > So it should document mainly how to depend on it, and where to find the > Javadoc (and maybe some usage examples). > > For Hupa I think there was a new maintainer who asked to take it back and we > can see there is a little activity on it: > https://github.com/apache/james-hupa/ > > Maybe it's worth asking him... > > Regards, > > Raphaël. > > Le 14/05/2020 à 08:38, David Leangen a écrit : >> Hi! >> >> For the documentation project, I am trying to get the lay of the land with >> regards to the sub-projects and related projects. >> >> My understanding is that this is the list of projects: >> >> • https://github.com/apache/james-project (of course) >> • https://github.com/apache/james-mime4j A library for parsing Mime objects >> • https://github.com/apache/james-jsieve A library for sieve script >> parsing and execution >> • https://github.com/apache/james-jspf A library for SPF record parsing >> and checks >> • https://github.com/apache/james-jdkim A library for DKIM record parsing >> and checks >> • Hupa, a James based MUA effort >> >> First question: is this list complete? Are these all that is required to set >> up an enterprise mail server? Or are there any other pieces that are missing >> from this picture? >> >> Otherwise, here is my initial impression from the documentation. Sorry if my >> understand is very different from reality, and please do not take offence! >> :^) My comments are about the website at http://james.apache.org/, not the >> GitHub pages. >> >> >> Mime4J: very little traffic on the list, almost no updates to the website >> for several years. Website is extremely sloooooooow, so I gave up trying to >> read the site. The project does not appear to be very complex. Perhaps we >> could simply move this to a single GitHub README page, and remove this >> portion of the website entirely. >> >> jSieve: also appears to be not very active for several years. Website is >> very slow. Nice to have references to the standards, but the website does >> not appear to be very useful right now. There is a mention of a mailing list >> on this page (http://james.apache.org/jsieve/mail-lists.html), but it >> directs only to a generic list, which seems wrong. Not sure what to do here. >> Again, maybe remove this section and just go with a GitHub page?? >> >> jSPF: the latest “news” is form 2010!! This section has very little >> information. Can definitely remove and go with only a GitHub README page. >> >> jDKIM: hmmm. Same thing. >> >> Hupa: does anybody use this? The last release is 0.0.3 from 2012. >> >> >> Each of the above could either be a GitHub page on its own, or the GitHub >> page could refer to the new documentation I am working on, and they could >> each have a section in the new docs. In any case, it is probably safe to >> completely remove these outdated websites. >> >> But beyond just the websites… perhaps it’s time to do a major Spring >> cleaning in the code itself, and maybe even the project structure?? This >> seems to me like a lot of dead weight... >> >> >> Any thoughts? >> >> >> Cheers, >> =David >> >> >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: [email protected] >> For additional commands, e-mail: [email protected] >> >> > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
