[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Simplifying our documentation

From: Julian Foad <julianfoad_at_apache.org>
Date: Fri, 30 Aug 2019 16:09:22 +0100

(Updated subject)

Nathan Hartman wrote in thread "Change to Subversion PMC rule for
approving backports":
> Julian Foad wrote:
>> I strongly urge that we simplify any and all of our documentation at any
>> opportunity. Nearly all of it is much too long. It would be much better
>> to state the facts in a few bullet points, and move the discussion of
>> rationale and history to a dedicated subsection so readers just wanting
>> the facts can easily skip that part.
> Which document would you consider most important to fix the soonest?

In line with current transition to emphasise stabilization and
availability, I suppose these user-facing docs should take priority:

   * finding/downloading/installing svn from *binaries*:
     - http://subversion.apache.org/packages

   * how to contact us; reduce/combine some of these?
     - http://subversion.apache.org/reporting-issues
     - http://subversion.apache.org/docs/community-guide/issues
     - http://subversion.apache.org/mailing-lists
     - http://subversion.apache.org/docs/community-guide/mailing-lists
     - http://subversion.apache.org/faq#more-information
     - http://subversion.apache.org/security/

   * and the home page should make those things extremely easy to find:
     - http://subversion.apache.org/

If you or anyone wants to help, I think any of those would be an
excellent place to do so.

The various contact info is particularly scattered, and pointers often
state "users@" email with no hint of the IRC/Matrix alternative. Could
we make a good "contact us" landing page which directs users
appropriately to all forms of contact?

- Julian
Received on 2019-08-30 17:09:24 CEST

This is an archived mail posted to the Subversion Dev mailing list.