summaryrefslogtreecommitdiff
path: root/contributing
diff options
context:
space:
mode:
authorSamuel Thibault <samuel.thibault@ens-lyon.org>2011-05-22 23:28:55 +0200
committerSamuel Thibault <samuel.thibault@ens-lyon.org>2011-05-22 23:28:55 +0200
commit6b94a96e2a5ae896b5565125f0299d335020b31b (patch)
treeb2f329d411057dcdde32159abbae27679ed6a61b /contributing
parent87feec09d8ae280fdc8dfa841b206ba53ec75ebf (diff)
parent1e66915496c673410798f396b932ccda019f7498 (diff)
Merge branch 'master' of flubber:~hurd-web/hurd-web
Diffstat (limited to 'contributing')
-rw-r--r--contributing/web_pages/news.mdwn112
-rw-r--r--contributing/web_pages/news/merge-news13
-rw-r--r--contributing/web_pages/news/moth_next.mdwn44
-rw-r--r--contributing/web_pages/news/skeleton.mdwn44
-rw-r--r--contributing/web_pages/news/writing_the_moth.mdwn77
5 files changed, 152 insertions, 138 deletions
diff --git a/contributing/web_pages/news.mdwn b/contributing/web_pages/news.mdwn
index a700c3ad..54fa788d 100644
--- a/contributing/web_pages/news.mdwn
+++ b/contributing/web_pages/news.mdwn
@@ -1,4 +1,5 @@
-[[!meta copyright="Copyright © 2009, 2010 Free Software Foundation, Inc."]]
+[[!meta copyright="Copyright © 2009, 2010, 2011 Free Software Foundation,
+Inc."]]
[[!meta license="""[[!toggle id="license" text="GFDL 1.2+"]][[!toggleable
id="license" text="Permission is granted to copy, distribute and/or modify this
@@ -8,103 +9,28 @@ Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license
is included in the section entitled [[GNU Free Documentation
License|/fdl]]."]]"""]]
-[[!meta title="""How to prepare and publish "a month of the Hurd" for the last
+[[!meta title="""How to prepare and publish a "Month of the Hurd" for the last
month"""]]
-We prepare *a month of the Hurd* in a public git branch (`master-news_next`),
-and merge that one into `master` once we want to publish the news. The idea is
-to record to-be-published changes on that branch at they time they arise, and
-then publish them en bloc at the end of the month.
+We prepare a *Month of the Hurd* in the file [[moth_next]]. The idea is
+to record to-be-published changes in that file at they time they arise, and
+then publish them en bloc at the end of the month. There are instructions for
+[[writing_the_moth]].
-As this is done on a separate branch, there are two options: you can have
-separate repositories (*clones*, or *checkouts*; what you get from `git clone`)
-for the `master` and `master-news_next` branches, or you can deal with both in
-the same repository. Having separate repositories you don't have to remember
-which branch you're on, and don't have to switch between branches before
-beginning to edit files, and it doesn't matter -- as no switching between
-branches is needed -- if you have uncomitted changes to some files. On the
-other hand, you may want to keep it all in one repository, to save disk space,
-and for shuffling different branches' commits being (a bit) easier.
+ * At the end of the month: prepare for publishing the MotH, then send the raw
+ Markdown text to the mailing list, asking for feedback.
-For practical work that means to use the following commands:
+ * ..., and publish.
- * create a local branch for `master-news_next`
-
- $ git fetch
- $ git checkout -b master-news_next origin/master-news_next
-
- * if you already have created a local branch `master-news_next`: update to
- the latest version of it
-
- $ git checkout master-news_next
- $ git pull --rebase
-
- * edit
-
- Always do check which branch you're on (asterisk in the first column of
- `git branch`'s output), and only then begin to do your changes and commit
- them.
-
- We should not update news items that have already been published (that is,
- on <http://www.gnu.org/software/hurd/news.html>; no problem for the
- [[staging area|web_pages#staging_area]]), as the system will always also
- update the RSS feeds, etc., causing the old news item to reappear on feeds,
- which is a bit of a nuisance.
-
- * at the beginning of a month: create a new news entry
-
- $ cp contributing/web_pages/news/skeleton.mdwn news/YYYY-MM.mdwn
- $ # edit the new file, then add the changes in git
- $ git add news/YYYY-MM.mdwn
- $ git commit -m "Begun the news entry for YYYY-MM."
-
- That is, use the [[news skeleton|skeleton]] as a template for the new
- news snippet. It also includes a list of the places to watch for news.
-
- * check the outgoing changes
-
- $ git log --reverse -p -C origin/master-news_next..master-news_next
-
- * push the changes
-
- $ git push origin master-news_next
-
- * if push fails, pull and rebase the local changes on top of the remote
- changes
-
- $ git pull --rebase
-
- This will only happen if someone else has been installing commits into
- `origin`'s `master-news_next` branch since the last time you
- synchronized to it.
-
- Note that this might cause some conflicts to arise -- if the remote
- repository contains commits that conflict with any that you've been
- recording in your local repository. For this reason, you might want to
- already do this *rebase* before beginning you local edits, simply to
- shorten the time frame in which such conflicts can arise.
- (Theoretically, in the very rare case of very much concurrent editing
- going on, you'd have to repeat this again (and again...) before
- succeeding to push your changes.)
-
- * at the end of the month: prepare for publishing the news
+ $ git mv contributing/web_pages/news/moth_next.mdwn news/YYYY-MM.mdwn
Edit the news entry's *meta date* value to the timestamp when the news
- entry is [[published|news]]. We have to set that one manually, as
- otherwise the timestamp of the news entry file's creation will be taken,
- which is (much) earlier, and not what we want. We do not set the *meta
- updated* value, as it's correct to update that one upon further
- modifications of the news entries.
-
- * ... and publish
-
- $ git checkout master
- $ git pull --rebase
- $ git merge master-news_next
+ entry is published. We have to set that one manually, as otherwise the
+ timestamp of the news entry file's creation will be taken, which is (much)
+ earlier, and not what we want. We do not set the *meta updated* value, as
+ it's correct to update that one upon further modifications of the news
+ entries.
+
+ $ git cp contributing/web_pages/news/skeleton.mdwn contributing/web_pages/news/moth_next.mdwn
+ $ git commit -m 'MotH YYYY-MM.'
$ git push origin master
-
- That means, for publishing we merge `master-news_next` into `master`.
- After that merge, work for the next month's news item can continue on
- `master-news_next`.
-
- Arne Babenhauserheide uses a [[merge-news]] script for doing this.
diff --git a/contributing/web_pages/news/merge-news b/contributing/web_pages/news/merge-news
deleted file mode 100644
index 33c01b7b..00000000
--- a/contributing/web_pages/news/merge-news
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/bin/sh
-
-# merge into master
-git checkout master
-git pull --rebase
-git merge master-news_next
-
-# push master
-git push origin master
-
-# switch back to master-news_next
-git checkout master-news_next
-git pull --rebase
diff --git a/contributing/web_pages/news/moth_next.mdwn b/contributing/web_pages/news/moth_next.mdwn
new file mode 100644
index 00000000..1d543634
--- /dev/null
+++ b/contributing/web_pages/news/moth_next.mdwn
@@ -0,0 +1,44 @@
+[[!meta copyright="Copyright © 2011 Free Software Foundation, Inc."]]
+
+[[!meta license="""[[!toggle id="license" text="GFDL 1.2+"]][[!toggleable
+id="license" text="Permission is granted to copy, distribute and/or modify this
+document under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no Invariant
+Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license
+is included in the section entitled [[GNU Free Documentation
+License|/fdl]]."]]"""]]
+
+<!-- Date when the news item is (to be) pulished (important for RSS feeds).
+Will be set by tschwinge when publishing.
+[[!meta date="YYYY-MM-DD HH:MM UTC"]]
+-->
+
+<!-- This is just a skeleton. Use it to create a new MotH. -->
+
+A month of the Hurd: *TODO*, *TODO*, and *TODO*.
+[[!if test="included()" then="""[[!toggle id=full_news
+text="Details."]][[!toggleable id=full_news text="[[!paste id=full_news]]"]]"""
+else="
+[[!paste id=full_news]]"]]
+
+[[!cut id="full_news" text="""
+
+<!--basic structure of a MotH entry. Adapt, reduce and add points as needed. At the end, try to make the text flow as a whole.-->
+
+This month [hurd hacker] [item]
+
+Also …
+
+[our hackers] …
+
+Mainly thanks to …
+
+Additionally …
+
+And …
+
+[reason for contibuting to the Hurd]
+
+<!--see [[contributing/web_pages/news/writing_the_moth]] for additional information on writing the MotH.-->
+
+"""]]
diff --git a/contributing/web_pages/news/skeleton.mdwn b/contributing/web_pages/news/skeleton.mdwn
index 9867fd21..1d543634 100644
--- a/contributing/web_pages/news/skeleton.mdwn
+++ b/contributing/web_pages/news/skeleton.mdwn
@@ -13,7 +13,9 @@ Will be set by tschwinge when publishing.
[[!meta date="YYYY-MM-DD HH:MM UTC"]]
-->
-A month of the Hurd: *TODO* / *TODO* / *TODO*.
+<!-- This is just a skeleton. Use it to create a new MotH. -->
+
+A month of the Hurd: *TODO*, *TODO*, and *TODO*.
[[!if test="included()" then="""[[!toggle id=full_news
text="Details."]][[!toggleable id=full_news text="[[!paste id=full_news]]"]]"""
else="
@@ -21,44 +23,22 @@ else="
[[!cut id="full_news" text="""
-Watch these places for news:
-
- * GNU
-
- * <http://lists.gnu.org/archive/html/bug-hurd/YYYY-MM/threads.html>
-
- * <http://lists.gnu.org/archive/html/commit-hurd/YYYY-MM/threads.html>
-
- * <http://lists.gnu.org/archive/html/help-hurd/YYYY-MM/threads.html>
-
- * <http://lists.gnu.org/archive/html/web-hurd/YYYY-MM/threads.html>
-
- * <http://lists.gnu.org/archive/html/hurd-devel/YYYY-MM/threads.html>
-
- * <http://sourceware.org/ml/libc-alpha/YYYY-MM/>
-
- Also Git log.
-
- * (<http://sourceware.org/ml/libc-hacker/YYYY-MM/>)
-
- * (<http://sourceware.org/ml/glibc-cvs/YYYY-qQ/>)
-
- Better use the Git log.
+<!--basic structure of a MotH entry. Adapt, reduce and add points as needed. At the end, try to make the text flow as a whole.-->
- * <http://lists.gnu.org/archive/html/l4-hurd/YYYY-MM/threads.html>
+This month [hurd hacker] [item]
- * Debian
+Also …
- * <http://lists.debian.org/debian-hurd/YYYY/MM/>
+[our hackers] …
- * <http://lists.debian.org/debian-glibc/YYYY/MM/>
+Mainly thanks to …
- * Arch Hurd
+Additionally …
- * <http://www.archhurd.org/news.php>
+And …
- * <http://planet.archhurd.org/>
+[reason for contibuting to the Hurd]
- * (<http://lists.archhurd.org/devel/maillist.html>)
+<!--see [[contributing/web_pages/news/writing_the_moth]] for additional information on writing the MotH.-->
"""]]
diff --git a/contributing/web_pages/news/writing_the_moth.mdwn b/contributing/web_pages/news/writing_the_moth.mdwn
new file mode 100644
index 00000000..82a25088
--- /dev/null
+++ b/contributing/web_pages/news/writing_the_moth.mdwn
@@ -0,0 +1,77 @@
+[[!meta copyright="Copyright © 2010, 2011 Free Software Foundation, Inc."]]
+
+[[!meta license="""[[!toggle id="license" text="GFDL 1.2+"]][[!toggleable
+id="license" text="Permission is granted to copy, distribute and/or modify this
+document under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no Invariant
+Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license
+is included in the section entitled [[GNU Free Documentation
+License|/fdl]]."]]"""]]
+
+# Short Guide for Writing the MotH
+
+
+## Individual News Items
+
+The basic structure for a news item is as follows: *\[person with](link) did
+\[task with}(link to testable code/patch) which brings us further towards
+\[[goal]] by [short, easily understandable description of the contribution]*.
+
+Each news item should show a step towards the mission of the Hurd. From
+[[community/weblogs/antrik/hurd-mission-statement]] you can
+glean the following basic goals:
+
+ * Better support for day-to-day desktop use (more packages, more stable, more
+ drivers, easier to setup, ...).
+ * More user freedom and possibilities for programs/translators.
+ * Technical advancement.
+ * More unique or at least interesting features.
+ * Attract more developers and/or users.
+
+The reason for this structure is to resolve the problem that many people think
+that the Hurd won't ever be finished by concentrating on the improvements and
+the steps towards completing our mission -- but only once they have actually
+been done (to avoid showing anything which might become vaporware).
+
+
+## Sources for News Items
+
+Watch these places for news:
+
+ * GNU
+
+ * <http://lists.gnu.org/archive/html/bug-hurd/YYYY-MM/threads.html>
+
+ * <http://lists.gnu.org/archive/html/commit-hurd/YYYY-MM/threads.html>
+
+ * <http://lists.gnu.org/archive/html/help-hurd/YYYY-MM/threads.html>
+
+ * <http://lists.gnu.org/archive/html/web-hurd/YYYY-MM/threads.html>
+
+ * <http://lists.gnu.org/archive/html/hurd-devel/YYYY-MM/threads.html>
+
+ * <http://sourceware.org/ml/libc-alpha/YYYY-MM/>
+
+ Also Git log.
+
+ * (<http://sourceware.org/ml/libc-hacker/YYYY-MM/>)
+
+ * (<http://sourceware.org/ml/glibc-cvs/YYYY-qQ/>)
+
+ Better use the Git log.
+
+ * <http://lists.gnu.org/archive/html/l4-hurd/YYYY-MM/threads.html>
+
+ * Debian
+
+ * <http://lists.debian.org/debian-hurd/YYYY/MM/>
+
+ * <http://lists.debian.org/debian-glibc/YYYY/MM/>
+
+ * Arch Hurd
+
+ * <http://www.archhurd.org/news.php>
+
+ * <http://planet.archhurd.org/>
+
+ * (<http://lists.archhurd.org/devel/maillist.html>)