summaryrefslogtreecommitdiff
path: root/HowToContributeToThisWiki.mdwn
diff options
context:
space:
mode:
authorThomas Schwinge <tschwinge@gnu.org>2007-08-09 03:12:40 +0200
committerThomas Schwinge <tschwinge@gnu.org>2007-08-09 03:12:40 +0200
commit6f62cfdc2c649add0416dcafc5b3c3d5c5e1aa0f (patch)
tree866c48732f7df964826a788d2b4539a6971e5035 /HowToContributeToThisWiki.mdwn
parentd9d53c976bd8f8cb96a1241fb1a3d088cd965fad (diff)
Aggregate the two git checkout possibilities.
Diffstat (limited to 'HowToContributeToThisWiki.mdwn')
-rw-r--r--HowToContributeToThisWiki.mdwn117
1 files changed, 57 insertions, 60 deletions
diff --git a/HowToContributeToThisWiki.mdwn b/HowToContributeToThisWiki.mdwn
index aaf41d86..38892b73 100644
--- a/HowToContributeToThisWiki.mdwn
+++ b/HowToContributeToThisWiki.mdwn
@@ -1,9 +1,7 @@
# How to Contribute to This Wiki
-There are essentially three possibilities. They are outlined below.
-
-
-Some general hints; just as in software projects:
+Some general hints first; they may sound very familiar from other software
+projects:
* Do independent changes *separately*: don't aggregate changes that don't
belong together.
@@ -11,17 +9,6 @@ Some general hints; just as in software projects:
until you think it is perfect.
-If you are editing the source files from a git checkout you can nevertheless
-have them get rendered to html pages:
-
- $ wiki/render_locally
- [...]
- scanning HowToContributeToThisWiki.mdwn
- rendering HowToContributeToThisWiki.mdwn
-
- Now open `wiki.rendered/index.html' to browse the wiki pages.
-
-
## Edit Via the Web Interface
When you found a page you want to work on, just follow the *Edit* link on the
@@ -30,17 +17,36 @@ you to a page where you have to create a wiki account. After logging in, you
can edit the wiki pages.
-## Do an Anonymous Checkout of the git Repository
+## Working on a Checkout of the git Repository
-*Not yet available.*
+*NOTE*: What is being described here are only the basics. The checkouts are
+completely valid git repositories and can (and want to) be treated as such.
+Consult the git documentation about how to shuffle around with branches, how to
+rename files, and so on.
+
+
+For being able to do a checkout from which you can later directly push your
+changes back into the master repository, you need a
+[[shell_account_on_*flubber*|Hurd/PublicHurdBoxen]]. (It's also very much
+recommenable that you set up your local ssh configuration as advised on that
+page.)
+
+ $ git clone flubber:~wiki/wiki [dest]
-Check out the wiki.
+If you don't have such an account or don't have your login data handy, you can
+still get the pages the read-only way.
+
+*Not yet available.*
$ git clone git://flubber.bddebian.com/wiki [dest]
-If you omit *[dest]* it will default to *wiki*.
+For both cases: if you omit *[dest]* it will default to *wiki*.
+
+Later, you can just *cd* into the *wiki* directory and run a *git pull* to get
+hold of the latest changes others have installed.
-Then you can work on these files.
+
+But now: work on these files.
$ cd wiki/
$ emacs Hurd/NextHurd.mdwn
@@ -51,53 +57,25 @@ Then you can work on these files.
[...]
$ [...]
-Prepare to publish your changes.
+Remember that at this stage your commits have only been installed into your
+personal working copy. So, finally you'll explicitly have to install your
+changes into the master repository.
- $ git-format-patch -M -B origin
- 0001-Be-a-bit-more-expressive.patch
- [...]
-See through the prepared **.patch* files and simply delete those you don't want
-to pulish.
+You can also get them locally rendered to html pages.
-Finally, publish the good ones. If you have a local mail transfer agent
-running, this is as simple follows.
-
- $ git-send-email --to web-hurd@gnu.org *.patch
+ $ wiki/render_locally
[...]
+ scanning HowToContributeToThisWiki.mdwn
+ rendering HowToContributeToThisWiki.mdwn
+
+ Now open `wiki.rendered/index.html' to browse the wiki pages.
-If you don't have an mta running, you'll have to find another way: either post
-the **.patch* files to <web-hurd@gnu.org> or upload them somewhere for us to
-download from.
-
-
-## Do a Read-write Checkout of the git Repository
-
-For being able to do that you need a
-[[shell_account_on_*flubber*|Hurd/PublicHurdBoxen]]. (It's very much
-recommenable that you set up your local *ssh* configuration as advised on that
-page.)
-
-Check out the wiki.
-
- $ git clone flubber:~wiki/wiki [dest]
-
-If you omit *[dest]* it will default to *wiki*.
-Then you can work on these files.
+If you like what you've done, then it's now time to publish your changes.
- $ cd wiki/
- $ emacs Hurd/NextHurd.mdwn
- $ git commit Hurd/NextHurd.mdwn
- [...]
- $ emacs Hurd/DesignGoals.mdwn
- $ git commit Hurd/DesignGoals.mdwn
- [...]
- $ [...]
-
-Remember that at this stage your commits have only been installed into your
-personal working copy. So you finally explicitly have to install your changes
-into the master repository.
+If you can push directly into the master repository this is as simple as
+follows.
$ git push
updating 'refs/heads/master'
@@ -106,3 +84,22 @@ into the master repository.
Generating pack...
[...]
Updating web pages. This may up to a few minutes at the utmost...
+
+If you can't do that, then first prepare to publish your changes.
+
+ $ git-format-patch -M -B origin
+ 0001-Be-a-bit-more-expressive.patch
+ [...]
+
+See through the generated **.patch* files and simply delete those you don't
+want to pulish.
+
+Finally, publish the good ones. If you have a local mail transfer agent
+running, the following is all you have to do.
+
+ $ git-send-email --to web-hurd@gnu.org *.patch
+ [...]
+
+If you don't have an mta running, you'll have to find another way: either post
+the **.patch* files to <web-hurd@gnu.org> or upload them somewhere for us to
+download them from.