aboutsummaryrefslogtreecommitdiff
path: root/documentation/tools
diff options
context:
space:
mode:
authorCeri Davies <ceri@FreeBSD.org>2021-05-14 14:53:36 +0000
committerCeri Davies <ceri@FreeBSD.org>2021-05-14 14:53:36 +0000
commit6fb837b028acd229492c371af77f381abbd463b0 (patch)
tree506856a9b4471862cfeac27242793f3f82346125 /documentation/tools
parentd7c59f682669783d499b6eb2d3c71875f618e9ac (diff)
Diffstat (limited to 'documentation/tools')
-rw-r--r--documentation/tools/README22
-rwxr-xr-xdocumentation/tools/addkey.sh7
2 files changed, 15 insertions, 14 deletions
diff --git a/documentation/tools/README b/documentation/tools/README
index 09841b1a81..c94aa28523 100644
--- a/documentation/tools/README
+++ b/documentation/tools/README
@@ -3,7 +3,7 @@
===============================
The addkey.sh script will export your key and generate the correct
-XML incantations to have your key listed in the "PGP Keys" chapter.
+incantations to have your key listed in the "PGP Keys" chapter.
It was written for GnuPG, but shouldn't be difficult to modify to use
PGP if you absolutely won't use GnuPG.
@@ -26,16 +26,16 @@ address. For instance, in my case:
| Adding key to entity list...
|
| Unless you are already listed there, you should now add the
-| following text to pgpkeys-developers.xml (unless this is a role key
-| or you are a core member. In that case add to pgpkeys-officers.xml
-| or pgpkeys-core.xml). Remember to keep the list sorted by last name!
+| following text to
+| documentation/content/en/articles/pgpkeys/_index.adoc (if this
+| is a role key or you are a core member, be careful to add to the
+| appropriate section of the same file).
+| Remember to keep the list sorted by last name!
|
-| <sect2 id="pgpkey-des">
-| <title>&a.des.email;</title>
-| &pgpkey.des;
-| </sect2>
+| === `{des}`
+| include::static/pgpkeys/des.key[]
|
-| Don't forget to 'svn add des.key' if this is a new entry,
+| Don't forget to 'git add des.key' if this is a new entry,
| and check your diffs before committing!
If your login name is different from your freefall login name, specify
@@ -68,7 +68,7 @@ Beware that the keys are supposed to be ordered by surname; if you're
unsure where to add your entry, use finger(1) to check the surnames of
those around you.
-Once you've successfully run addkey.sh, 'svn add' your key file, check
+Once you've successfully run addkey.sh, 'git add' your key file, check
the diffs, and commit.
@@ -77,7 +77,7 @@ the diffs, and commit.
There are two ways to update your key. The first is to follow the
above instructions as if you were adding your key for the first time -
-except that you don't need to edit chapter.xml, because you're
+except that you don't need to edit pgpkeys/_index.adoc, because you're
already listed there. The addkey.sh script will snarf the RCS Id from
the old key file and generate a new one with whatever keys you
specified.
diff --git a/documentation/tools/addkey.sh b/documentation/tools/addkey.sh
index 9ded01d68e..9b77bdf4df 100755
--- a/documentation/tools/addkey.sh
+++ b/documentation/tools/addkey.sh
@@ -129,10 +129,11 @@ info "Generating ${keyfile}..."
cat <<EOF
-Remember to move ${keyfile} to /static/pgpkeys/
+Remember to move ${keyfile} to documentation/static/pgpkeys/
-If this is a new entry, don't forget to run the following commands
-before committing:
+If this is a new entry, add a relevant entry to
+documentation/content/en/articles/pgpkeys/_index.adoc and
+don't forget to run the following commands before committing:
% git add ${keyfile}