Add instructions for updating the doc/ are of the website.
This probably needs further elaboration; I'm not sure this really even belongs in the PEP, though.
This commit is contained in:
parent
41b0a48d85
commit
2aa4a939f1
106
pep-0101.txt
106
pep-0101.txt
|
@ -234,9 +234,88 @@ How to Make A Release
|
||||||
$ ssh creosote.python.org mkdir $TARGET
|
$ ssh creosote.python.org mkdir $TARGET
|
||||||
$ scp *-$VERSION.* creosote.python.org:$TARGET
|
$ scp *-$VERSION.* creosote.python.org:$TARGET
|
||||||
|
|
||||||
XXX What's needed to describe posting the documentation on the
|
___ For final releases, publish the documentation on python.org.
|
||||||
website should be added here, or there should be a link to a
|
This must be done by someone with write access to the python.org
|
||||||
document in the python.org site management documentation.
|
CVS repository.
|
||||||
|
|
||||||
|
Start by creating a new directory and filling it with the
|
||||||
|
standard boilerplate. $VERSION is the same as for uploading the
|
||||||
|
documentation, above; $OLDVERSION is the most recently published
|
||||||
|
version on the site.
|
||||||
|
|
||||||
|
$ cd .../pydotorg/doc/
|
||||||
|
$ mkdir $VERSION
|
||||||
|
$ cvs add $VERSION
|
||||||
|
$ cd $OLDVERSION
|
||||||
|
$ cp .cvsignore Makefile index.ht download.ht ../$VERSION
|
||||||
|
$ cd ../$VERSION
|
||||||
|
$ cvs add .cvsignore Makefile *.ht
|
||||||
|
|
||||||
|
Now make the following edits:
|
||||||
|
|
||||||
|
- in Makefile, change the value of ROOT_OFFSET to doc/$VERSION
|
||||||
|
|
||||||
|
- in index.ht, change:
|
||||||
|
- the version number to $VERSION in two places: the Title:
|
||||||
|
header, and the <h3> at the top of the page
|
||||||
|
- the release date, in the <h3> at the top of the page
|
||||||
|
- if the minor release number changed (for example, from 2.3
|
||||||
|
to 2.4), the title and link to the "What's New" document
|
||||||
|
(search for "whatsnew")
|
||||||
|
|
||||||
|
- in download.ht, change:
|
||||||
|
- the version number to $VERSION in two places: the Title:
|
||||||
|
header, and the <h3> at the top of the page
|
||||||
|
- the release date, in the <h3> at the top of the page
|
||||||
|
- if the minor release number changed (for example, from 2.3
|
||||||
|
to 2.4), the title and link to the "What's New" document
|
||||||
|
(search for "whatsnew")
|
||||||
|
- replace the large table of downloads with the content of the
|
||||||
|
pkglist.html file generated by the documentation build
|
||||||
|
process
|
||||||
|
|
||||||
|
Now, the web content has all been prepared, but there's still
|
||||||
|
some dancing to do to make it all work right. To be safe, we
|
||||||
|
can commit the new files to CVS, but we're *not* ready to
|
||||||
|
install them on the site yet:
|
||||||
|
|
||||||
|
$ cvs commit -m \
|
||||||
|
"Add website content for Python $VERSION documentation."
|
||||||
|
|
||||||
|
Log into creosote.python.org using SSH and unpack a copy of the
|
||||||
|
documentation into place:
|
||||||
|
|
||||||
|
# on creosote:
|
||||||
|
$ cd /ftp/www.python.org/doc
|
||||||
|
$ tar xjf \
|
||||||
|
/ftp/ftp.python.org/pub/python/doc/$VERSION/html-$VERSION.tar.bz2
|
||||||
|
$ mv Python-Docs-$VERSION $VERSION
|
||||||
|
|
||||||
|
Now head back to your pydotorg checkout on your workstation, and
|
||||||
|
push website content into place:
|
||||||
|
|
||||||
|
$ cd .../pydotorg/doc/$VERSION
|
||||||
|
$ make install
|
||||||
|
|
||||||
|
Point your browser at this URL and check it out:
|
||||||
|
|
||||||
|
http://www.python.org/doc/$VERSION/
|
||||||
|
|
||||||
|
There are three more changes that need to happen in the
|
||||||
|
top-level doc/ directory of the website content. The first of
|
||||||
|
these can happen any time after what's already happened in this
|
||||||
|
process, and the last two should happen as soon as the release
|
||||||
|
announcement has been made.
|
||||||
|
|
||||||
|
At this time, edit the versions.ht file in doc/ to make add the
|
||||||
|
new release at the top. The previous latest release should drop
|
||||||
|
down to the top of the long list of released versions, and the
|
||||||
|
new release should replace the previous most recent release.
|
||||||
|
There should be a blank line between the link to the development
|
||||||
|
documentation and the most recent release, and another blank
|
||||||
|
line between the most recent release and the long list of older
|
||||||
|
releases. (Is should be fairly easy to figure this out while
|
||||||
|
looking at the file.)
|
||||||
|
|
||||||
___ Thomas grabs the HTML to build the Windows helpfile.
|
___ Thomas grabs the HTML to build the Windows helpfile.
|
||||||
The HTML files are unpacked into a new src/html directory, and
|
The HTML files are unpacked into a new src/html directory, and
|
||||||
|
@ -461,6 +540,27 @@ How to Make A Release
|
||||||
|
|
||||||
Feel free to remove any old news items.
|
Feel free to remove any old news items.
|
||||||
|
|
||||||
|
___ Make the last two changes to the documentation area on
|
||||||
|
python.org. (Remember those from the documentation items above?
|
||||||
|
It's time now.)
|
||||||
|
|
||||||
|
In your pydotorg checkout, edit the file doc/index.ht to update
|
||||||
|
to the right version number and release date. Commit the
|
||||||
|
changes to CVS and push the file to the website:
|
||||||
|
|
||||||
|
$ cd .../pydotorg/doc/
|
||||||
|
$ make install
|
||||||
|
|
||||||
|
This will cause the doc/index.html file to claim to point to the
|
||||||
|
new docs, but they won't. Run (don't walk!) to
|
||||||
|
creosote.python.org, and update a symlink in the doc/ tree:
|
||||||
|
|
||||||
|
# on creosote:
|
||||||
|
$ cd /ftp/www.python.org/doc/
|
||||||
|
$ rm current && ln -s $VERSION current
|
||||||
|
|
||||||
|
Good. Stop running.
|
||||||
|
|
||||||
Now it's time to do some cleaning up. These steps are very important!
|
Now it's time to do some cleaning up. These steps are very important!
|
||||||
|
|
||||||
___ If you made a non-maintenance branch, be sure to merge it into
|
___ If you made a non-maintenance branch, be sure to merge it into
|
||||||
|
|
Loading…
Reference in New Issue