[pydotorg-www] Docs development entrypoint (Was: [docs] Mailing list dead pile and private lists)

anatoly techtonik techtonik at gmail.com
Sun Apr 25 14:10:42 CEST 2010


"There should be one-- and preferably only one --obvious way to do it."

Current status:

docs at python.org - public support mailling list
docs-sig at python.org - non-intuitive development name, but it's
documentation development group
Web pages:
http://mail.python.org/mailman/listinfo/docs
http://mail.python.org/mailman/listinfo/doc-sig (outdated)
http://www.python.org/community/sigs/current/doc-sig/status/
http://www.python.org/community/sigs/current/doc-sig/
http://www.python.org/dev/doc/
http://docs.python.org/bugs.html#documentation-bugs
http://docs.python.org/documenting/index.html

I see problems:
- too many entrypoints (hard to maintain)
- no main entrypoint with this list for maintenance
- ML members do not have access to update status / collaborate
- no web access to ML

I propose:
1. have doc@ alias  (I had troubles remembering correct doc@ or docs@ name)
2. rename doc-sig@ to doc-dev@ (or docs-dev@?)
3. merge various HTML pages (including mailman) into one/two
entrypoint page and allow community update it
4. 3 obviously requires a Wiki page
5. add web posting interface with OAuth/OpenID support (Google Groups,
anything else?)
6. add custom search form for doc development archives and docs
(twisted has one for mailman)

(I still don't understand people who don't like web interfaces, but
still firing email agent to fill their GUI email form fields that is
no different from web-based except that fields are not autofilled
using browser cookie).

Does it look like a plan?
-- 
anatoly t.



On Sun, Apr 25, 2010 at 1:08 PM, Georg Brandl <georg at python.org> wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Am 25.04.2010 10:11, schrieb anatoly techtonik:
>> On Fri, Apr 23, 2010 at 11:16 PM, Aahz <aahz at pythoncraft.com> wrote:
>>>
>>> Martin already mentioned mail.python.org, but I wanted to highlight it
>>> because it has an HTTP server for Mailman, so it contains all the mailing
>>> list archives and going to http://mail.python.org/ shows the public
>>> mailing lists.
>>
>> The important part of it is that private archives are not listed.
>> For example docs at python.org (or is it doc at python.org?) is almost
>> impossible for volunteer to discover that it is possible to
>> participate. There is also Doc-SIG, but it is not very active.
>>
>> So, I propose to review current SIGs ML, private ML and merge/remove
>> or archive dead ML.
>>
>> The question to whatever to make docs/doc@ public is for Georg. I
>> can't insist on things I am not actively participate in.
>
> I've already decided to make the docs archives public.  However, the
> previous archives have to be removed first; like for pydotorg, I do
> not want them to be publicly available when the senders thought
> otherwise.  As soon as the postmasters have archived the archive :)
> the new archives will be public.
>
> As for doc-SIG and docs at python.org: the former is for the discussion
> of the "how" of our documentation -- how to write it, how to build it,
> what features it should have.  The latter is for day-to-day handling
> of issues and reports/comments people send to docs at python.org.  Think
> of it like the difference between python-dev and the tracker/checkins
> lists.
>
> Also, if you want to post more to docs at python.org, I would recommend
> to subscribe, otherwise I'll have to moderate all your posts.
>
> Georg
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v2.0.14 (GNU/Linux)
>
> iEYEARECAAYFAkvUFIAACgkQN9GcIYhpnLAmBQCcD+hHFht78ZXxGvIIXbR9wzqT
> OU4AnA5dPxgOXUvM+UEWkjlgSjfB69p9
> =5irg
> -----END PGP SIGNATURE-----
>


More information about the pydotorg-www mailing list