|
|
||||||||||||||||||||||||||||||||||||||||||
|
Python.org Maintenance and AdministrationThis document is incomplete; we're updating it as questions come up. If you have questions, try the webmaster alias first, then pydotorg if you don't get a response. Getting startedThe python.org web site uses SVN for revision control. The repository has the hostname svn.python.org. If accepted as a site maintainer, use these instructions for checking out a working copy of the site: Use SVN to check out a working copy of the site and supporting packages (HT2HTML and docutils): $ svn co https://svn.python.org/www/trunk/ <accept the SSL certificate for svn.python.org> <enter SVN username> <enter SVN password> Updating Web ContentThe basic steps for updating a web page:
Subversion's post-commit hook feature is used to update the live site when you commit a file ending in '.ht'. The modified file is checked out on the live server and make is executed in the file's directory. (Some other extensions are automatically updated; currently the list is '.ht', '.h', '.asc', '.rst', '.html', and '.txt'.) If you edit the Makefile or the HTML generation scripts, you'll have to perform the update manually; the post-commit hook ignores such changes as a security measure. You'll need to have SSH access to the machine to do this; if you only have SVN access, you'll have to ask someone with SSH access to update the server. Assuming you have SSH access, here's how to perform a manual installation:
When you create a directory, you need to create a Makefile in the new directory. The Makefile should look like: ROOT_DIR=<relative path to web root> ROOT_OFFSET=<relative path to current directory from root> include $(ROOT_DIR)/scripts/make.rules $(TARGETS): links.h For an example, take a look at dev/pydotorg/Makefile. The Makefile also needs to be checked in. Note that ROOT_DIR and ROOT_OFFSET should be the only definitions placed before the include statement; all other definitions, dependencies, and command lists should come after. Note: If you add files, make sure that they have read permissions for both group and world. If you add directories, make sure they have write permissions for group. (Not sure how this works on Windows --Aahz) Note: Be careful about updating the mirror list; that uses a slightly different procedure. Read the HTML comment at the top of Mirrors.ht. There is also a Translators' Guide to Python.org. Site mapTo cause the site map to ignore a directory, add a .sitemap-ignore file. Files generated from .ht files can be omitted from the sitemap by including the following header: Sitemap-Ignore: yes Content Style(General information about writing content should go here.) When editing content maintained as HTML in .ht files, sample code should be presented using a <pre> element. Sample code content should be indented as it would be in a Python source file, and example interactive sessions should be presented with the prompts on the left margin. In no case should additional indentation be added to "push" the example code to the right; that will be handled using style sheets. Such content maintained as reStructuredText must be indented to conform to reStructuredText rules, but the formatting tools for reStructuredText already do the right thing in this case. Mailing ListsThere are three mailing lists for python.org maintainers; many maintainers but not all are on all the lists, but not everyone is on both lists. All lists are run from the python.org domain.
The following additional addresses are used in collecting information in the process of maintaining python.org; these also are hosted in the python.org domain.
IRCOccasionally volunteers will use IRC to communicate: the server used is irc.freenode.net, on the #pydotorg channel. MachinesThere are several machines which support the operation of python.org, all of which are currently hosted by XS4ALL. The primary machine is www.python.org (also known as "dinsdale.python.org"). This machine hosts the static content of the site and some light CGI scripts (the FAQ Wizard, in particular).
The following people are available for emergency root access to machines. Contact should be attempted through the pydotorg list first.
Mail processing occurs on mail.python.org. Barry Warsaw maintains the Mailman installation on that machine. Old SourceForge SiteThe python.sourceforge.net site is no longer being actively maintained; its purpose is now largely filled by the Developers section on the main site. The only content still being provided from that server is the collection of CVS snapshots. |