path: root/greek/devel/website/desc.wml

#use wml::debian::template title="How is www.debian.org made"
#use wml::debian::toc
#use wml::debian::translation-check translation="6d9ec7201dcfa229e0cdf7f93c34b3d4a8509ebe" maintainer="galaxico"

<p>The Debian <em>&ldquo;webtree&rdquo;</em>, collection of directories and files
that comprise our web site, is located in the <tt>/org/www.debian.org/www</tt>
directory on www-master.debian.org. The bulk of the pages are normal static
HTML files (i.e. not produced with something dynamic such as a CGI or a PHP
script), because the web site is mirrored.

<p>The site is generated in one of three ways:
<ul>
  <li>the bulk of it is generated using WML, from the 
      <a href="$(DEVEL)/website/using_git"><q>webwml</q> git repository</a>
  <li>the documentation is generated either using DocBook XML (use of DebianDoc
      SGML is being phased out), from the
      <a href="$(DOC)/vcs"><q>ddp</q> git repository</a>; or
      using <a href="#scripts">cron scripts</a>, from the corresponding
      Debian packages
  <li>parts of the site are generated using scripts using other sources,
      e.g. the mailing list (un)subscription pages
</ul>

<p>An automatic update (from the git repository and other sources to the
webtree) is being run six times a day.

<p>If you'd like to contribute to the site, do <strong>not</strong> simply
add to or edit items in the <code>www/</code> directory. Contact
<a href="mailto:webmaster@debian.org">the webmasters</a> first.

<p>All the files and directories are owned by group debwww and writable
by that group, so the web team can modify files in the web directory. The
2775 mode on directories means that any files created under that directory
will inherit the group - debwww in this case.  Anyone in group debwww is
expected to set '<code>umask 002</code>' so that the files are created with
group write permissions.

<toc-display />

<hrline />


<toc-add-entry name="look">Look &amp; feel</toc-add-entry>

<p>We give the pages the same look and feel by having
<a href="https://packages.debian.org/unstable/web/wml">WML</a> do all
the detail work of adding headers and footers to pages. Although a .wml page
may look like HTML at first glance, HTML is only one of the types of extra
information that can be used in .wml. After WML is finished running its various
filters over a file, the final product is true HTML. To give you an idea of
the power of WML, you can include Perl code into a page to allow you to do,
well, almost anything.

<p>Note however that WML checks (and sometimes automagically corrects) only
the very basic validity of your HTML code. You should install
<a href="https://packages.debian.org/unstable/web/weblint">weblint</a>
and/or
<a href="https://packages.debian.org/unstable/web/tidy">tidy</a>
to validate your HTML code.

<p>Our web pages currently comply to the
<a href="http://www.w3.org/TR/html4/">HTML 4.01 Strict</a> standard.

<p>Anyone who is working on a lot of pages should install WML so they can
test to make sure the result is what they want. If you are running Debian,
you can easily install the <code>wml</code> package. Read the pages on
<a href="using_wml">using WML</a> for more information.


<toc-add-entry name="sources">Sources</toc-add-entry>

<p>The source for the web pages is stored under git. git is a version
control system, which allows us to keep a log of which, who, when, and why changes
occurred, etc. It is a safe way to control the concurrent editing of source
files among multiple authors, which is crucial for us because the Debian web
team is rather large in size.

<p>If you are unfamiliar with this program, you will want to read the pages
on <a href="using_git">using git</a>.

<p>The topmost webwml directory in the git repository contains directories
named after the languages the web site is in, two makefiles and several
scripts. The translation directory names should be in English and lowercase
(e.g. "german", not "Deutsch").

<p>The more important of the two makefiles is Makefile.common, which, as its
name says, contains some common rules which are applied by including this
file in the other makefiles.

<p>Each of the language directories contains makefiles, WML source files and
subdirectories. The file and directory names do not differ in order to keep
the links correct for all languages. The directories may also contain .wmlrc
files which contain some information useful to WML.

<p>The webwml/english/template directory contains special WML files that we
call templates, because they can be referenced from all other files using the
<code>#use</code> command.

<p>In order for changes in the templates to propagate to the files which use
them, the files have makefile dependencies on them. Since a vast majority of
the files use the "template" template, by having a
"<code>#use wml::debian::template</code>" line at the top, the generic
dependency (the one for all files) is that very template. There are
exceptions to this rule, of course.


<toc-add-entry name="scripts">Scripts</toc-add-entry>

<p>The scripts are mostly written in shell or Perl. Some of them are
standalone, and some of them are integrated into WML source files.</p>

<p>The sources for the main www-master rebuild scripts are in the
<a href="https://salsa.debian.org/webmaster-team/cron.git">webmaster-team/cron
Git repository</a>.
</p>

<p>The sources for the packages.debian.org rebuild scripts are in the
<a href="https://salsa.debian.org/webmaster-team/packages">webmaster-team/packages
Git repository</a>.</p>


<toc-add-entry name="help">How to help</toc-add-entry>

<p>We invite everyone interested to help us make the Debian site as good as
it can be. If you have valuable information related to Debian that you think
our pages are missing, <a href="mailto:debian-www@lists.debian.org">share it
with us</a> and we'll see that it gets included.

<p>We could always use help with designing pages (regarding graphics and
layouts), and keeping our HTML clean, too. We regularly run the following
checks on the whole web site:</p>

<ul>
  <li><a href="https://www-master.debian.org/build-logs/urlcheck/">URL check</a>
  <li><a href="https://www-master.debian.org/build-logs/validate/">wdg-html-validator</a>
  <li><a href="https://www-master.debian.org/build-logs/tidy/">tidy</a>
</ul>

<p>Help is always welcome in reading the above logs and fixing the problems.</p>

<p>The current build logs for the web site can be found at
<url "https://www-master.debian.org/build-logs/">.</p>

<p>If you're a fluent English speaker, we'd like you to proof-read our pages
and report all errors to <a href="mailto:debian-www@lists.debian.org">us</a>.

<p>If you speak another language, you may want to help us translate the
pages to your language. If a translation has already been made, but has
problems, take a look at the list of <a href="translation_coordinators">\
translation coordinators</a> and talk to the leader for your language
about fixing it. If you'd like to translate pages yourself, see the page on
<a href="translating">that topic</a> for more information.

<p>There's also a <a href="todo">TODO file</a>, check it out.</p>


<toc-add-entry name="nohelp">How <strong>not</strong> to help</toc-add-entry>

<p><em>[Q] I want to put <var>fancy web feature</var> into www.debian.org,
may I?</em>

<p>[A] No. We want www.debian.org to be as accessible as possible, so
<ul>
    <li>no browser specific "extensions".
    <li>no relying on images only. Images may be used to clarify, but the
        information on www.debian.org must remain accessible via a text-only
        web browser, like lynx.
</ul>

<p><em>[Q] I have this nice idea. Can you enable FOO in www.debian.org's
HTTPD, please?</em>

<p>[A] No. We want to make life easy for administrators to mirror
www.debian.org, so no special HTTPD features please. No, not even SSI.
An exception has been made for content negotiation. This is because it
is the only robust way to serve multiple languages.