summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Schwinge <thomas@schwinge.name>2011-04-24 12:50:42 +0200
committerThomas Schwinge <thomas@schwinge.name>2011-04-24 12:50:42 +0200
commit5e44d0c6010c2ebcedc32988fcf119f8d0f42e3d (patch)
treee456d60ae2945bc635717f2d61521072ee1d3885
parent104c04198b262acfd37eff592447a4cc431bd798 (diff)
contributing: Change some bits.
-rw-r--r--contributing.mdwn80
-rw-r--r--contributing/web_pages.mdwn10
-rw-r--r--open_issues.mdwn10
3 files changed, 69 insertions, 31 deletions
diff --git a/contributing.mdwn b/contributing.mdwn
index 191451a0..e3a7a1f1 100644
--- a/contributing.mdwn
+++ b/contributing.mdwn
@@ -14,39 +14,47 @@ License|/fdl]]."]]"""]]
So, you are interested in contributing to the GNU Hurd project? Welcome!
Every single contribution is very much encouraged.
-There are various ways to contribute; read on about contributing to...
+There are various ways to contribute; read up on contributing to...
[[!toc levels=3]]
If someone of you is lurking around here and would like to contribute, but
-feels she / he could do so better under formal mentoring: please speak up at
-one of the [[regular_IRC_meetings|IRC#regular_meetings]]!
+feels she / he could do so better under formal mentoring: please
+[[contact_us]], or just speak up at one of the [[regular IRC
+meetings|IRC#regular_meetings]]!
-Generally we also have a list of [[open_issues]] and one for
-[[project_ideas|community/gsoc/project_ideas]] - the latter written for the
-Google Summer of Code. Even just investigating open issues, without being able
-to fix them, can be useful, because a tracked down issue often becomes obvious
-to people who know the stuff (but those people don't have the time to spend to
-do the tracking down).
+We also have a list of [[open_issues]] and one for more elaborate [[project
+ideas|community/gsoc/project_ideas]] - the latter originally written for the
+[[Google Summer of Code|community/gsoc]], but not exclusively. Even just
+investigating open issues, without being able to fix them, can be useful,
+because a issue that has been tracked down often becomes obvious to address for
+people who know the stuff -- but these people typically don't have the time
+that is needed to track down the issues.
# Documentation
-## These Web Pages
-Please read about [[how_to_contribute_to_these_web_pages|web_pages]].
+## Technical Writer
+
+Our hackers (programmers) typically do what their kind always does: they code.
+What they don't like too much is documenting their wonderful achievements. On
+the other hand, there are people (you?) who enjoy documenting technical
+matters, so don't hesitate to [[contact_us]] if technical documentation shall
+be your contribution to GNU Hurd development.
+
+## Web Pages
-# The System Itself
+Please read about [[how_to_contribute_to_these_web_pages|web_pages]].
-There are essential two kinds of Hurd system designs.
-<a name="hurd_on_mach"> </a>
-## Hurd on Mach
+<a name="hurd_on_mach"></a>
+# Improve GNU Hurd Running on GNU Mach
-For one there's the implementation of the *[[Hurd]] running on the
-[[GNU_Mach_microkernel|microkernel/mach/gnumach]]*. This is what is commonly
-meant when people are talking about GNU/Hurd systems.
+The *[[GNU Hurd|hurd]] running on the [[GNU Mach
+microkernel|microkernel/mach/gnumach]]* is what is commonly meant when people
+are talking about GNU/Hurd systems.
This system has mostly been designed and implemented
[[in the '90s|history]]. It works and is usable.
@@ -82,7 +90,8 @@ For more reading resources, please see these web pages, for example,
[[Mach_documentation|microkernel/mach/documentation]] for links to a bunch of
documents.
-### Porting Packages
+
+## Porting Packages
Debian is currently the Hurd distribution of choice among Hurd users and
developers.
@@ -95,14 +104,34 @@ doesn't work or suit you and try to improve that.
You can also have a look at the [List of failing packages](http://people.debian.org/~sthibault/failed_packages.txt).
-### Open Issues
-Here is a list of [[open_issues]].
+## Open Issues
+
+There is a list of [[open_issues]]. This list includes everything from bug
+reports to open-ended research questions.
-<a name="insta-dev-env"> </a>
-### Instant development environment
+
+<a name="insta-dev-env"></a>
+## Instant Development Environment
+
+<!-- I don't like this being here. At least not in this form. This just
+duplicates information that is available in other places. (Or should be
+available in other places, in more elaborate form.)
+
+The idea of a one-stop development environment is not bad (I like that), but
+I'd do this differently. For example, we should add some Git submodules to the
+master hurd.git repository (which is currently empty), to branches that are
+known to build and interface correctly with current GNU/Hurd system
+installations (thus including TLS, etc.), and also add in my cross-gnu scripts
+and a simple build machinery so this is usable from GNU/Linux (and other
+systems), and so on and so forth.
+
+I'll have to think about it some more.
+
+--[[tschwinge]]. -->
*This is a very brief guide to get your development environment set up. Pester ArneBab @ irc.freenode.net on IRC if something does not work :)*
+([[!taglink open_issue_documentation]])
* Install qemu-kvm via your distros packages.
* Download the [qemu image](http://people.debian.org/~sthibault/hurd-i386/debian-hurd.img.tar.gz): `wget http://people.debian.org/~sthibault/hurd-i386/debian-hurd.img.tar.gz`
@@ -120,8 +149,9 @@ Here is a list of [[open_issues]].
* Start hacking.
* For shutting down, use `reboot`, then press `c` in grub and issue halt (to avoid filesystem corruption). Adding `--no-reboot` to the qemu line should help, too.
-<a name="hurd_on_modern_microkernel"> </a>
-## Hurd on a modern microkernel
+
+<a name="hurd_on_modern_microkernel"></a>
+# Design / Research: GNU Hurd on a Modern Microkernel
Developers [[have_identified|hurd/critique]] a number of problem with the *Hurd on
Mach* system. Problems, that can not easily be fixed by bug-fixing the
diff --git a/contributing/web_pages.mdwn b/contributing/web_pages.mdwn
index 351c82bd..d1b3c0fc 100644
--- a/contributing/web_pages.mdwn
+++ b/contributing/web_pages.mdwn
@@ -6,8 +6,8 @@ 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]]."]]"""]]
+is included in the section entitled [[GNU Free Documentation
+License|/fdl]]."]]"""]]
[[!meta title="Contribute to the Web Pages"]]
@@ -48,6 +48,12 @@ we do have some simple requests. Please try to match the *tone* of your topics
and edits with the existing topics. If we all pull in the same direction these
pages will be more useful for everyone, especially for our own use.
+### Which Pages to Work on?
+
+If you don't know which pages to work on, please have a look at those tagged
+with [[tag/open_issue_documentation]]. Typically, you'll have to look at the
+pages' source code (Markdown) to see which parts the tag applies to.
+
### News Items
There are [[more detailed instructions about editing news items|news]].
diff --git a/open_issues.mdwn b/open_issues.mdwn
index dbc33bdd..f77c1983 100644
--- a/open_issues.mdwn
+++ b/open_issues.mdwn
@@ -1,16 +1,18 @@
-[[!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
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]]."]]"""]]
+is included in the section entitled [[GNU Free Documentation
+License|/fdl]]."]]"""]]
[[!meta title="Open Issues"]]
-This is a dumping ground for open issues.
+This is a dumping ground for open issues. This list includes everything from
+bug reports to open-ended research questions.
[[!inline
pages=none