Date: Fri, 14 May 2021 14:54:27 GMT From: Ceri Davies <ceri@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 6fb837b028 - main - Update instructions on adding new committer entries. Approved by: blackend (mentor) Message-ID: <202105141454.14EEsRuc098089@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by ceri: URL: https://cgit.FreeBSD.org/doc/commit/?id=6fb837b028acd229492c371af77f381abbd463b0 commit 6fb837b028acd229492c371af77f381abbd463b0 Author: Ceri Davies <ceri@FreeBSD.org> AuthorDate: 2021-05-14 14:53:36 +0000 Commit: Ceri Davies <ceri@FreeBSD.org> CommitDate: 2021-05-14 14:53:36 +0000 Update instructions on adding new committer entries. Approved by: blackend (mentor) --- .../en/articles/committers-guide/_index.adoc | 5 ++-- documentation/static/pgpkeys/README | 30 ++++++++++++---------- documentation/tools/README | 22 ++++++++-------- documentation/tools/addkey.sh | 7 ++--- 4 files changed, 34 insertions(+), 30 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 5dff0376eb..26329f5f4b 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -2226,7 +2226,6 @@ These steps must be done by a mentor for those who are not committers. Those who have been given commit rights to the FreeBSD repositories must follow these steps. * Get mentor approval before committing each of these changes! -* The [.filename]#.ent# and [.filename]#.xml# files mentioned below exist in the FreeBSD Documentation Project SVN repository at `svn+ssh://repo.FreeBSD.org/doc/`. * All [.filename]#src# commits go to FreeBSD-CURRENT first before being merged to FreeBSD-STABLE. The FreeBSD-STABLE branch must maintain ABI and API compatibility with earlier versions of that branch. Do not merge changes that break this compatibility. [[commit-steps]] @@ -2239,9 +2238,9 @@ Those who have been given commit rights to the FreeBSD repositories must follow [.filename]#doc/shared/authors.adoc# - Add an author entity. Later steps depend on this entity, and missing this step will cause the [.filename]#doc/# build to fail. This is a relatively easy task, but remains a good first test of version control skills. . Update the List of Developers and Contributors + -[.filename]#doc/en/articles/contributors/contrib-committers.adoc# - Add an entry to the "Developers" section of the link:{contributors}#staff-committers[Contributors List]. Entries are sorted by last name. +[.filename]#doc/documentation/content/en/articles/contributors/contrib-committers.adoc# - Add an entry, which will then appear in the "Developers" section of the link:{contributors}#staff-committers[Contributors List]. Entries are sorted by last name. + -[.filename]#doc/en/articles/contributors/contrib-additional.adoc# - _Remove_ the entry from the "Additional Contributors" section. Entries are sorted by first name. +[.filename]#doc/documentation/content/en/articles/contributors/contrib-additional.adoc# - _Remove_ the entry. Entries are sorted by first name. . Add a News Item + [.filename]#website/data/en/news/news.toml# - Add an entry. Look for the other entries that announce new committers and follow the format. Use the date from the commit bit approval email from mailto:core@FreeBSD.org[core@FreeBSD.org]. diff --git a/documentation/static/pgpkeys/README b/documentation/static/pgpkeys/README index 1f14f5cefb..9b12fcd5f4 100644 --- a/documentation/static/pgpkeys/README +++ b/documentation/static/pgpkeys/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,15 +26,15 @@ 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! -| -| <sect2 id="pgpkey-des"> -| <title>&a.des.email;</title> -| &pgpkey.des; -| </sect2> -| +| 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! +| +| === `{des}` +| include::static/pgpkeys/des.key[] +| | Don't forget to 'git add des.key' if this is a new entry, | and check your diffs before committing! @@ -77,9 +77,10 @@ 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 -already listed there. The addkey.sh script will generate a new key -file with whatever keys you specified. +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. The second method, which you can use if you're not adding or removing any keys, but just updating the ones that are already there (because @@ -95,3 +96,6 @@ freefall login name. -- des@freebsd.org + + +$FreeBSD$ 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}
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202105141454.14EEsRuc098089>