[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNU-traductores] old-gnudist:/home/www/html/server/standards/README.htm
|
From: |
old-gnudist's file diff daemon |
|
Subject: |
[GNU-traductores] old-gnudist:/home/www/html/server/standards/README.html -- New file |
|
Date: |
Tue, 15 Jan 2002 06:29:18 -0800 (PST) |
This is an automated report from old-gnudist.
This appears to be a new file or has only recently been added to
the list of monitored files:
21 -rw-rw-r-- 1 webcvs www 20174 Dec 20 02:18
/home/www/html/server/standards/README.html
Contents:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE>GNU Webmaster Guidelines - GNU Project - Free Software Foundation
(FSF)</TITLE>
<LINK REV="made" HREF="mailto:address@hidden";>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#1F00FF" ALINK="#FF0000"
VLINK="#9900DD">
<H3>GNU Webmaster Guidelines</H3>
<!-- When using this boilerplate, remember to replace the "???" in both places
above. -->
<!-- when you replace this graphics, make sure you change the link
to also point to the correct html page.
If you make a new graphics for this page, make sure it has
a corresponding entry in /graphics/graphics.html -->
<A HREF="/graphics/atypinggnu.html"><IMG SRC="/graphics/gnu-type-sm.jpg"
ALT=" [image of the typing GNU] "
WIDTH="137" HEIGHT="114"></A>
<P>
<HR>
<P>
<H4>Table of Contents</H4>
<UL>
<LI><A NAME="TOC0" HREF="README.html#SEC0">Organisation</A>
<LI><A NAME="TOC00" HREF="README.html#SEC00">How to edit www.gnu.org/... ?</A>
<LI><A NAME="TOC01" HREF="README.html#SEC01">Symbolic Links</A>
<LI><A NAME="TOC1" HREF="README.html#SEC1">Style guidelines</A>
<LI><A NAME="TOC2" HREF="README.html#SEC2">Webmasters</A>
<LI><A NAME="TOC3" HREF="README.html#SEC31">CVS and timestamps</A>
<LI><A NAME="TOC3" HREF="README.html#SEC3">.emacs and timestamps</A>
<LI><A NAME="TOC4" HREF="README.html#SEC4">umask</A>
<LI><A NAME="TOC5" HREF="README.html#SEC5">Using the <CODE>TAGS</CODE> file</A>
<LI><A NAME="TOC6" HREF="README.html#SEC6">Groups on files</A>
<LI><A NAME="TOC7" HREF="README.html#SEC7">Update the What's New page!</A>
<LI><A NAME="TOC8" HREF="README.html#SEC8">Update the Sitemap page?</A>
<LI><A NAME="TOC9" HREF="README.html#SEC9">Update GNUs Flashes on the home page
http://www.gnu.org/</A>
<LI><A NAME="TOC10" HREF="README.html#SEC10">Check your HTML!</A>
<LI><A NAME="TOC11" HREF="README.html#SEC11">More webmaster tasks</A>
<LI><A NAME="TOC12" HREF="README.html#SEC12">Archive of
<address@hidden></A>
<LI><A NAME="TOC13" HREF="README.html#SEC13">Scripts</A>
<LI><A NAME="TOC14" HREF="README.html#SEC14">Cron Jobs</A>
<LI><A NAME="TOC15" HREF="README.html#SEC15">Adding FTP mirrors</A>
<LI><A NAME="TOC16" HREF="README.html#SEC16">Audio and video files</A>
<LI><A NAME="TOC17" HREF="README.html#SEC17">Adding an Event</A>
</UL>
<P>
<HR>
<P>
Everything (well, most everything ;-)
you always wanted to know about www.gnu.org!
<P>
<H4><A NAME="SEC0" HREF="README.html#TOC0">Organisation</A></H4>
In order to work as a webmaster you need one of the following:
<UL>
<LI> Become a developer for one of the GNU packages managed by
<a HREF="http://savannah.gnu.org/";>Savannah</a>. This will
allow you to edit the portion of the www.gnu.org web that
is devoted to this GNU package, as shown in the
<a HREF="www2savannah.html">www.gnu.org to Savannah projects map</a>.
<LI> Become a member of the <a HREF="http://savannah.gnu.org/projects/www/";>
www</a> project in order to edit the whole tree.
<LI> A shell account on gnudist.gnu.org,
ask to <a HREF="mailto:address@hidden";>address@hidden</a>.
</UL>
<P>
The whole www.gnu.org web site is stored under CVS on
subversions.gnu.org. Most of the webmaster tasks do not require a
shell account on gnudist.gnu.org and are a lot simpler to perform by
checking out the pages on your local machine, modifying them and then
committing the result. For an example of instructions on how to use
CVS for this purpose, see the <a
HREF="http://savannah.gnu.org/cvs/?group_id=2";>CVS instructions for
the GNU mifluz package</a>.
<P>
When a commit is done, a synchronization process will update the
www.gnu.org web site immediately. At the end of the commit operation
the changes should be visible at www.gnu.org. If it's not the case,
complain to <a HREF="mailto:address@hidden";>address@hidden</a>.
<P>
In order to be granted edit permissions for a project you must first
<a HREF="https://savannah.gnu.org/account/register.php";>register yourself</a>
on Savannah. This is a very simple step that anyone can do.
<P>
A small number of tasks do require to logon gnudist.gnu.org and if you
want to devote some time to them you'll need to ask for a shell account.
<P>
Instead of having a single group of users who have edit permissions
over the whole www.gnu.org CVS tree, a number of groups have been
created and only have edit permissions on a specific directory
tree. For instance, the <a
HREF="http://savannah.gnu.org/projects/bravegw/";>Brave GNU World</a>
project members only have edit permissions on the <a
HREF="http://www.gnu.org/brave-gnu-world/";>http://www.gnu.org/brave-gnu-world/</a>
directory. This has a number of advantages such as easily finding out
who is in charge of which portion of the www.gnu.org web site. A
<a HREF="www2savannah.html">www.gnu.org to Savannah projects map</a> is
updated every day and shows which directories are handled by which projects.
<P>
Some parts of the www.gnu.org web site do not yet have a matching
project on Savannah. Don't hesitate to
<a HREF="http://savannah.gnu.org/register/";>create a project</a> for a
given subdirectory if you plan to work on it with other
webmasters. When creating the project, select the <i>website only</i>
license. The /software/<i>package</i> directories have a special
status since they must be bound to a project that have the same name
on Savannah and are associated to a source CVS repository. You should
try to get in touch with the package maintainer before creating a
project in /software/<i>package</i>.
<P>
Since it would be very complicated for highly involved webmasters to become
a member of each and every projects when they want to make some global
changes, the special project <a HREF="http://savannah.gnu.org/projects/www/";>
www</a> was created. Each member of the <i>www</i> project is granted
edit permission over the whole www.gnu.org CVS repository.
<P>
If you want more information about Savannah, read the
<a HREF="README.savannah.html">Administration Guide</a>.
<H4><A NAME="SEC00" HREF="README.html#TOC00">How to edit www.gnu.org/...
?</A></H4>
If you want to edit the pages you are responsible for or want to become
responsible for a specific subdirectory, proceed as follows:
<UL>
<LI>Go to the <a HREF="www2savannah.html">www.gnu.org projects map</a>. If
the directory you're interested in is already listed here, contact the
people in charge to get write access. You don't have anything else to
do. Anyone in charge of this directory will be able to grant you write
access to the CVS respository.
<LI>If the directory you're interested in is not listed, logon <a
href="http://savannah.gnu.org/";>Savannah</a> and register a new
project whose purpose is simply <b>Edit the
www.gnu.org/thedirectory/</b>. Within 24h the project will be
validated and you'll be able to checkout this portion of the web
read/write.
</UL>
If you want to understand more about www.gnu.org, CVS and Savannah,
read the <A HREF="README.html#SEC0">Organisation</A> chapter and the Savannah <A
HREF="README.savannah.html">Administration Guide</A>.
<H4><A NAME="SEC01" HREF="README.html#TOC01">Symbolic Links</A></H4>
Since CVS is not able to handle symbolic links, a simple mechanism has
been implemented on the machine hosting the www.gnu.org to allow
webmasters to control the symbolic link from the CVS tree.
<P>
By adding special files (".symlinks") into the CVS tree that are
interpreted as specficiations to build symbolic links. The
"symlinks" script can be run immediately after a "cvs update"
to fix the symbolic links according to the specifications
included in the ".symlinks" files.
<P>
The current directory is searched recursively for ".symlinks" files.
Symbolic links that exist in directory where there is no
.symlinks files will be ignored. Only directories containing a
.symlinks file are handled.
<P>
Each symbolic link specification from the ".symlinks" file is honored,
i.e. the symbolic link is created if it does not exist yet. If a
symbolic link is found in the directory and is not listed in the
".symlinks" file, it is removed.
<P>
Special handling to comply to the GNU webmaster standard
is also applied. If a subdirectory "foo/bar" has no
"foo/bar/index.html" file and a file "foo/bar/bar.html"
exists, then a symbolic link from "index.html" to
"bar.html" is created even if it is not listed in the
.symlinks file. In short, an implicit
<PRE>
cd foo/bar ; ln -s bar.html index.html
</PRE>
is done.
<P>
Symbolic links that point outside the web site
document root are ignored.
<P>
The ".symlinks" files obey to the following format.
<P>
Each line starting with a sharp sign ("#") is treated as a
comment and ignored.
<P>
Lines that do not contain two strings separated by white
space are silently ignored.
<P>
Here is an example of .symlinks file content:
<PRE>
#
# Link foo.html to bar.html.
# Stricly equivalent to ln -s foo.html bar.html
#
foo.html bar.html
</PRE>
<P>
On each line the first file name must be a relative path
name to an existing file. The file designated by this path
must not be outside the document root. The second file
name may not contain any slash, it is the name of the sym-
bolic link to be created.
<P>
The actual command used to implement this feature is symlinks(1) and
the sources can be found in
gnudist.gnu.org:/usr/local/src/symlinks-1.1.tar.gz.
<H4><A NAME="SEC1" HREF="README.html#TOC1">Style guidelines</A></H4>
Please read <a
href="/server/fsf-html-style-sheet.html">http://www.gnu.org/server/fsf-html-style-sheet.html</a>
before writing any HTML for www.gnu.org<P>
<H4><A NAME="SEC2" HREF="README.html#TOC2">Webmasters</A></H4>
New webmasters should read
<a href="/server/standards/README.webmastering.html">Information
on how to be a webmaster on www.gnu.org</a>
and review the
<A HREF="/server/standards/readme_index.html#readme">various
Readme's</A>.<P>
<H4><A NAME="SEC31" HREF="README.html#TOC31">CVS and timestamps</A></H4>
Each HTML file should contain a timestamp. Because we only recently
switched to CVS, there are still two ways that timestamps are done. The
preferred way is via CVS:
<PRE>
Updated:
<!-- timestamp start -->
$Date:$ $Author:$
<!-- timestamp end -->
<HR>
</PRE>
<P>
If you are working in a file that is stored by CVS, and such a timestamp
entry isn't in the file, please add it. If a file under CVS that you are
working in still uses the <PRE>hhmts</PRE> method for updates described
below, please switch it to the <PRE>timestamp</PRE> method.
<H4><A NAME="SEC3" HREF="README.html#TOC3">.emacs and timestamps</A></H4>
If the web directory you are working in isn't in CVS, please use this
method, via your .emacs, to update the timestamp.
<P>
The file <CODE>~www/.emacs</CODE>
contains some suggestions for your own <CODE>~/.emacs</CODE>.
In particular, what we want is numbered backups and the "Last updated"
field changed automatically on file write - this field is
the date and user name between these two comments lines:
<PRE>
<!-- hhmts start -->
18 Apr 2000 tower
<!-- hhmts end -->
</PRE>
An easy way to use them and get future updates is to add these lines
to your own <CODE>~/.emacs</CODE>:
<PRE>
(let ((www-emacs-file (expand-file-name "~www/.emacs")))
(if (file-exists-p www-emacs-file)
(load-file www-emacs-file)))
</PRE>
<P>
<H4><A NAME="SEC4" HREF="README.html#TOC4">umask</A></H4>
Your umask on www.gnu.org is set to 000 as default, please don't change
this.<P>
<H4><A NAME="SEC5" HREF="README.html#TOC5">Using the <CODE>TAGS</CODE>
file</A></H4>
A file <CODE>TAGS</CODE> in directory <CODE>~www/html/</CODE> lists
all the HTML files on this site. This files allow one to search
or query replace all of the HTML files.
See <A HREF="/TAGS.readme.html">these instructions</A>
for more information.
<P>
<H4><A NAME="SEC6" HREF="README.html#TOC6">Groups on files</A></H4>
All files in the html tree should have the group www, if a file does not
(and is not writable by world), please ask someone to change it.
<P>
<H4><A NAME="SEC7" HREF="README.html#TOC7">Update the What's New page!</A></H4>
When you add something significant to www.gnu.org, please add
an entry to
<A HREF="/server/whatsnew.html">/home/www/html/server/whatsnew.html</A>
<br>
Entries that can, should contain a <A HREF=" to the page (or section
of a page (<A ... NAME="...")) that has the newly added text.
(Multiple <A HREF=" are OK, if appropriate.)<BR>
Entries should be newest first, so repeat visitors to the page, see
the new items first. Note some users use automatic services that tell
them when WWW pages change - many point at "What's New!" pages at
sites they follow.<P>
<H4><A NAME="SEC8" HREF="README.html#TOC8">Update the Sitemap page?</A></H4>
When you add something <STRONG>very</STRONG> significant
to www.gnu.org, please add
an entry to /home/www/html/server/sitemap.html<br>
in the right section.
Entries that can, should contain a <A HREF=" to the page (or section
of a page (<A ... NAME="...")) that has the newly added text.
Multiple <A HREF=" are OK, if appropriate.
<P>
<H4><A NAME="SEC9" HREF="README.html#TOC9">Update GNUs Flashes on the home page
http://www.gnu.org/</A></H4>
If you update GNUs Flashes on the home page
<A HREF="/home.html">http://www.gnu.org/</A>,
please add the exact same text as an entry to
<A HREF="/server/whatsnew.html">/home/www/html/server/whatsnew.html</A>.
This way, a user can find the text again, after it is deleted from
the home page <A HREF="/home.html">http://www.gnu.org/</A>.
<P>
<H4><A NAME="SEC10" HREF="README.html#TOC10">Check your HTML!</A></H4>
<CODE>/usr/local/bin/htmlchek</CODE>
can and <STRONG>SHOULD</STRONG> be used to do a syntax and some
semantic checks on HTML files.<br>
You could also use <CODE>weblint</CODE> or other checkers
which may or may not be better.<P>
<H4><A NAME="SEC11" HREF="README.html#TOC11">More webmaster tasks</A></H4>
The file
<A HREF="/server/tasks.html">/home/www/html/server/tasks.html</A>
has the tasks it be good to do to our site, www.gnu.org.<BR>
The file
<A HREF="/server/BUGS.html">/home/www/html/server/BUGS.html</A>
has a list of known bugs that should be fixed ASAP.<P>
<H4><A NAME="SEC12" HREF="README.html#TOC12">Archive of
<address@hidden></A></H4>
You might want to <STRONG>review</STRONG> the archive of the mailing list
<STRONG><address@hidden></STRONG>.
It has discussions about the design of this site, and the
rationales for the design decisions.
It's on the gnu.org machines (for example mail.gnu.org) at UMB as
file <CODE>/com/archive/webmaster</CODE>
files <CODE>/com/archive/webmaster*.gz for the older messages</CODE>.
<P>
If you don't have an account on those machines, and have been appointed a
webmaster, please ask whomever appointed you a webmaster to arrange for an
account.<P>
<H4><A NAME="SEC13" HREF="README.html#TOC13">Scripts</A></H4>
For a description of scripts/software that is used on www.gnu.org, please
read <a
href="/server/source/source.html">http://www.gnu.org/server/source/source.html</a>.
Be sure to read that before trying to write any scripts that work with the
website, such as programs that automatically updated pages.
<P>
<H4><A NAME="SEC14" HREF="README.html#TOC14">Cron Jobs</A></H4>
The cron daemon as user www
<BR>
runs /usr/www/bin/web-backup, which sets up the file that mirror sites pick up,
<BR>
and also runs /home/www/bin/nightly, which among other tasks:<P>
<ul>
<li>mirrors files from prep (aka ftp.gnu.org)
and then converts any changed <CODE>*.texi</CODE> files
into <CODE>*.html</CODE> files,
then inserts end of HTML file copyright,
links, etc.<P>
<li>creates /home/www/html/TAGS, useful for making global changes
to all the html files via the GNU Emacs command tags-query-replace,
or searching all the html files via tags-search.<P>
Also creates files /home/www/html/TAGS.LG, that list those
translations in language LG, for the use of each
translation team.<P>
See <A HREF="/TAGS.readme.html">these instructions</A>
for more information.<P>
</ul>
The crontab file is in /home/www/crontab and you should modify that file
and install it into cron instead of modifying the system crontab.
Use the command <CODE>crontab -u www -e</CODE> to do this.
<P>
<H4><A NAME="SEC15" HREF="README.html#TOC15">Adding FTP mirrors</A></H4>
<P>
When adding a new ftp mirror, please update fencepost:/gd/gnuorg/FTP and
fencepost:/gd/gnuorg/FTP.contacts and not /prep/ftp.html. This is because
/prep/ftp.html is automatically generated from fencepost:/gd/gnuorg/FTP.
<P>
<H4><A NAME="SEC16" HREF="README.html#TOC16">Audio and video files</A></H4>
<P>
A 22Gb disk partition was allocated to audio and video files on the
machine audio-video.gnu.org. In order to add new files in this
repository, one should be registered as a member of the <a
href="http://savannah.gnu.org/projects/audio-video/";>GNU and FSF audio
video</a> project.
Uploading a file can be done using rsync over ssh
<pre>
rsync --rsh=ssh file.vob audio-video.gnu.org:/audio-video/video
</pre>
The access methods offered to users are:
<ul>
<li>
rsync
<pre>
rsync -av audio-video.gnu.org::audio-video .
</pre>
</li>
<li>
http
<pre>
<a href="http://audio-video.gnu.org/";>http://audio-video.gnu.org/</a>
</pre>
</li>
</ul>
<P>
<H4><A NAME="SEC17" HREF="README.html#TOC17">Adding an event</A></H4>
<P>
Webmasters should not usually add and remove events to our <a
href="/events.html">events page</a>, they should only update the
<code>events.input-html</code> file for formatting changes, etc. The
actual addition and removal of events is handled by
<code>fp:/gd/gnuorg/EventAndTravelInfo/announce-events.plx</code> and
<code>gnudist:~www/bin/auto-event-handle</code>.
<p>
However, from time to time, the webmasters might get an email to add an
event in error. There are two types of events webmasters might get:
<ul>
<li> Events of a type that
<code>fp:/gd/gnuorg/EventAndTravelInfo/announce-events.plx</code> can
already handle. Check the POD of the script itself for information on
whom to forward messages to. The short version: you should normally
forward a message to the person who is speaking, except in the case of
RMS---those go to <a
href="mailto:address@hidden";><address@hidden></a>.</li>
<li> Events of a type that are not supported yet. In that case, you
should always ask webmaster-escalate.
</ul>
In a pinch, someone from the FSF staff might ask the webmasters to add an
event in a hurry. In these cases, you can, if you want, figure out how to
edit the relevant file in <code>fp:/gd/gnuorg/EventAndTravelInfo/</code>.
If you can't figure that out, you can add the event to
<code>events.input-html</code> above the AUTO section. However, if you do
the latter, please take responsibility for the event and remove it when it
has passed.
<P>
<!--
* If needed, change the copyright block at the bottom. In general, all pages
on the GNU web server should have the section about verbatim copying. Please
do NOT remove this without talking with the webmasters first.
-->
<HR>
Return to <A HREF="/home.html">GNU's home page</A>.
<P>
Please send FSF & GNU inquiries & questions to
<A HREF="mailto:address@hidden";><EM>address@hidden</EM></A>.
There are also <A HREF="/home.html#ContactInfo">other ways to
contact</A> the FSF.
<P>
Please send comments on these web pages to
<A HREF="mailto:address@hidden";><EM>address@hidden</EM></A>,
send other questions to
<A HREF="mailto:address@hidden";><EM>address@hidden</EM></A>.
<P>
Copyright (C) 1999, 2001 Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA 02111, USA
<P>
Verbatim copying and distribution of this entire article is
permitted in any medium, provided this notice is preserved.<P>
Updated:
<!-- timestamp start -->
$Date: 2001/12/20 10:18:10 $ $Author: mohit $
<!-- timestamp end -->
<HR>
</BODY>
</HTML>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNU-traductores] old-gnudist:/home/www/html/server/standards/README.html -- New file,
old-gnudist's file diff daemon <=