[Reproducible-commits] [blog] 04/04: document how to use publish.sh

[Holger Levsen]

This is an automated email from the git hooks/post-receive script.

holger pushed a commit to branch master
in repository blog.

commit 5ee5695139ddb4ce5c6c7a4dce037d14259b91ea
Author: Holger Levsen <holger at layer-acht.org>
Date:   Wed May 18 14:55:50 2016 +0200

    document how to use publish.sh
---
 README | 39 +++++++++++++++++++++++++++++----------
 TODO   |  5 +----
 2 files changed, 30 insertions(+), 14 deletions(-)

diff --git a/README b/README
index d7c3d65..81a550f 100644
--- a/README
+++ b/README
@@ -15,11 +15,11 @@ Basically what need's to be done each week is:
 - publishing is simply done via git push.
 - polish drafts/$NR.mdwn until it's good.
 - ask for review and help on IRC.
-- git mv drafts/$NR.mdwn posts/
-- publish the final as the drafts, with git push.
+- publish the result with a simple git push.
 
 About each of these steps in a bit more detail:
 
+
 Doing the 9 steps to write the draft
 ------------------------------------
 
@@ -42,7 +42,7 @@ That README describes these steps:
 Read that README and follow those steps as described there.
 
 
-Turning the template into a draft and finishing it
+Turning the template into a draft and polishing it
 --------------------------------------------------
 
 Copy drafts/template.mdwn to drafts/$NR.mdwn in git, then do a commit and
@@ -52,12 +52,7 @@ on IRC.
 Unfinished drafts are available for easy review at
 https://reproducible.alioth.debian.org/blog/drafts/
 
-Then polish drafts/$NR.mdwn until it's good.
-
-Then just git mv drafts/$NR.mdwn posts/ ; git commit ; git push.
-
-Voila. Once it's in posts/ and has been pushed it will automatically show up
-on http://planet.debian.org - yay!
+Then polish drafts/$NR.mdwn until it's good. Ask for review on IRC.
 
 
 Doing local previews before committing to git
@@ -69,6 +64,30 @@ It's easy to preview before commiting changes, just run:
 	# point your webbrowser to http://localhost:8000
 
 
+Finally: Publishing
+-------------------
+
+To publish a post, please use bin/publish.sh as this will set the meta tags
+and the post date automatically.
+
+To review the tags which are guessed by the script:
+
+$ ./bin/publish.sh --dry-run 56		# --dry-run or -d
+
+Ideally the script should detect all tags automatically, if this is the case,
+run this command to prepare publishing - actuall publishing will still require
+`git push`:
+
+$ ./bin/publish.sh 56
+
+If you know in advance that you want to edit the tags (because you checked
+them with --dry-run), use `./bin/publish.sh --edit 56` (--edit or -e) instead.
+
+Voila. If you are happy with what has been committed to git locally by the
+script, run git push and the post will automatically show up on 
+http://planet.debian.org - yay!
+
+
 Personal posts
 --------------
 If you want to write personal blog posts about your experiences with
@@ -98,7 +117,7 @@ Writing a post
 
 While writing, there are some macros available that semplify the linking of
 common Debian resources.  These are:
-[[!pkg hello]] => [hello](https://tracker.debian.org/hello)
+[[!pkg hello]] => [hello](https://tracker.debian.org/pkg/hello)
 [[!bug 12345]] => [#12345](https://bugs.debian.org/12345)
 [[!patch 12345]] => [original patch](https://bugs.debian.org/12345)
 [[!issue time_in_foo]] => [time_in_foo](https://tests.reproducible-builds.org/issues/unstable/time_in_foo_issue.html)
diff --git a/TODO b/TODO
index a8bee98..3fcbef6 100644
--- a/TODO
+++ b/TODO
@@ -1,10 +1,7 @@
 #56 needs to be written and finished
-	should be published with bin/publish.sh to get the meta headers right
+	should be published using bin/publish.sh as documented in README
 	afterwards h01ger needs to run ikiwiki-calendar as documented below…
 
-to be documented:
-	bin/publish.sh
-
 TODO for bin/publish.sh:
 	run "ikiwiki-calendar -f /home/groups/reproducible/blog/blog.setup 'posts/*'" as holger on alioth to update the archive
 	should detect if committers are not listed in "This weeks edition was written by"…

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/blog.git