Differences between revisions 1 and 2
Revision 1 as of 2010-03-29 05:34:39
Size: 10914
Editor: fcestrada
Comment:
Revision 2 as of 2010-03-29 05:48:19
Size: 10955
Editor: fcestrada
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
||<tablewidth="100%" tablestyle=""style="border: 0px hidden ;">~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: [[fr/ProjectNews/HowToContribute|français]]-~ ||<style="border: 0px hidden ; text-align: right;"> (!) [[/Discussion]] || ||<tablewidth="100%" tablestyle=""style="border: 0px hidden ;">~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: [[ProjectNews/HowToContribute|English]], [[fr/ProjectNews/HowToContribute|Français]]-~ ||<style="border: 0px hidden ; text-align: right;"> (!) [[/Discussion]] ||

Translation(s): English, Français

(!) ?/Discussion


  • This page explains HOWTO contribute to ProjectNews and what YOU can do to help it.

HOWTO contribute

Contributing to ProjectNews is easy but depends on your skills and the amount of time you can spare.

Send interesting news

The easiest way to help us is to inform us about interesting things happening in the Debian universe. Debian is quite a big project, and we don't have the manpower to monitor every mailing list, blog, news site for content we might want to add to our ProjectNews. So tell us, if you noticed something interesting happening. You can usually do this by sending an E-Mail to debian-publicity@lists.debian.org .

What you should send

Generally speaking: Everything which might have an noticeable impact on the Debian Project at large and its user base is special.

Some ideas:

  • Discussion taking place on a mailing list, which:
    • have a noticeable impact (e.g. License Discussion, scheduled transition from
    • contain an interesting discussion regarding Project foo to Project bar General Resolutions, etc.)

  • Smaller announcements from sub projects:
    • debian installer about to release beta3, testing requested
    • French debconf translations reach 100%
    • cdrkit capable of burning blue ray discs
    • etc...
  • Interesting Bug Reports (ever looked at 245047?)

  • You represent Debian at a conference or exhibition (with a booth, talk, workshop, etc.)
    • You wrote a report after having represented Debian at a conference or exhibition
  • You were interviewed about your work on Debian
  • Debian related reviews / tests / articles in other media / web sites / mailing lists / blogs
  • etc...

Things you don't need to report

Of course the above list is far from being complete. We would especially like to point out, that we can't monitor other media, web sites, blogs and everything else. So it's very valuable to report anything you think fitting to the ProjectNews to our mailing lists debian-publicity@lists.debian.org .

Keep in mind, that one of the main purposes from our side, beside keeping our users informed, is to show them that

  • we are a living, working community! I.e. to show that things are done, that Debian is alive!

Help by native speakers

Currently the main editor is not a native English speaker. He knows it, and you probably have noticed it, too. So one thing you can help as a native speaker is to fix his en_DE to proper English. The issues are drafted in a subversion repository. Details on how to access is using a subversion client are listed bellow in the "Becoming an editor yourself" part. But even if you are unfamiliar with that, you can always download the current issue, review that and mail comments to the debian-publicity mailing list. We would prefer to receive your changes as diff or wdiff, if possible: Just make a copy of the downloaded file, edit it, and send us the output of diff <oldfile> <newfile>.

Becoming an editor yourself

If you want to contribute directly and want to add small articles for the ProjectNews yourself, feel free to join the team:

Accessing the subversion repository

Before accessing the subversion repository, you might want to read ?Setting up SSH the first time to use the subversion repository on alioth more conveniently.

  • run svn co svn+ssh://svn.alioth.debian.org/svn/publicity/dpn/en/current. This command will create a Folder current containing the current draft the Debian Project News. If you like, you may rename that folder into something more convenient for you.

  • Change into that directory. Whatever you do: Never delete or otherwise touch the .svn folder therein! It contains some meta date needed to maintain everything.

You can now edit the Debian Project News. Don't worry if you unexperienced with subversion or the Website Meta Language / HTML (which is used for Debian's website). Nothing you do will directly appear on the website and all errors you might do can be revoked relatively painlessly.

Editing

  • Change into the folder containing the checkout. Unless you renamed it, that would be current.

  • Before editing, you should run svn update. This will get your local copy up to date.

  • You may now edit index.wml as you like. See bellow for details of the format.

  • After you changed index.wml, please run svn update again. Just in case someone changed that document while you where working on it.

    • Subversion tries to be smart, when applying foreign changes to your changed document. Unless you changed the very same line, everything should work out pretty fine.
    • Should you have changed the very same lines, you have created a so called conflict, which must be resolved. Please see the svn book on how to do so.

  • Once your local copy is up to date, you can send your changes to the central repository by running svn -m "description of your changes" commit index.wml.

  • Congrats you just contributed to next issue of the Debian Project News!

Also note, that there are several graphical front ends for subversion. But as the writer lacks experience with any of them, he can't recommend them.

Two more other guidelines for committing your changes:

  1. Please use a useful commit message (the description of your changes behind the "-m" Parameter).
  2. Try not to make to long lines. Tracking changes / viewing diffs is easier, when the line length is shorter then ~80 characters. Most Editors can be teacht to automatically break the line for you.

Format of the index.wml file

The Debian Project News are available in three Formats:

All these formats are generated from the index.wml file. Debian's website use the website meta language (WML) to create the web pages. Roughly speaking is WML HTML with embedded macros (e.g. for common elements on various sited) and the possibility to embed perl scripts, e.g. to create a list of DPN issues based on the files available. But don't worry: You don't need to know WML or perl (and only basic HTML) to contribute to the DPN. Luckily nearly everything is already in place and we just need to create the content with minimal HTML markup.

If you look at an empty index.wml (you can look at this one which is used as template) you'll notice that it starts as follows:

#use wml::debian::projectnews::header PUBDATE="2010-XX-XX" SUMMARY=""
#use wml::debian::acronyms

The first line tell's the wml compiler, that he should use the project-news template for the header. It also sets two variables for the publishing date and a small summary. The summary is used for example at the index page for recent issues. It should be to long.

The aconyms line allows the use of specific acronyms, which will show the explanation as a hover text over the acronym. TODO: How does that work exactly? Haven't used it myself, yet.

At the end you'll see something similar:

#use wml::debian::projectnews::footer editor="XXX, XXX, Alexander Reichle-Schmehl"

That tells the wml compilter to add the normal footer to the web page. With the editor variable, it will also add the names of the contributors listed there.

Everything between these lines, is regular HTML, which in our case mostly means: Some headlines (<h2>...</h2>), some paragraphs (<p>...</p>) and some lists (<ul><li>...</li><li>...</li></ul>).

Every article should start with a headline:

<a name="1"></a>
<h2>This is the headline of my small article</h2>

The stuff between the <h2> and </h2> is the actual headline. The <a name="x"></a> creates a so called anchor used to directly jump to a specific entry. It's for example used in the RSS-feed.

After that follows the actual article between <p> and </p>. You may use several of these paragraphs, but note that only the first one will appear in the RSS-feed. (Which might be a bug worth fixing, if you know enough perl...)

As explained, you may use normal HTML in these paragraphs. This means:

  • <q>...</q> for quotes, citations or release names:

    • Debian 6.0 <q>squeeze</q>, Steve McIntyre said: <q>Booh!</q>

  • <a href="..."> for links:

    • The Secretary <a href="http://lists.debian.org/debian-devel-announce/2010/03/msg00000.html">called for nominates</a> for the project leader elections.

  • <!-- ... --> for comments, which won't appear on the website:

    • {<!-- TODO:  Add a link once this discussion has come to a conclusion! -->