Bug 261812 - Miscellaneous small changes to the Committer's Guide.
Summary: Miscellaneous small changes to the Committer's Guide.
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Pau Amma
URL: https://reviews.freebsd.org/D37091
Keywords:
Depends on:
Blocks:
 
Reported: 2022-02-09 06:01 UTC by Pau Amma
Modified: 2023-01-04 13:19 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Pau Amma 2022-02-09 06:01:25 UTC
In 13. Developer Relations, "Working on a bug in an area of the system which is clearly orphaned" should be "When working on a bug in an area of the system which is clearly orphaned".

In 17. Who’s Who:
- Section heading "FreeBSD committer’s mailing list" should be "FreeBSD commits mailing lists" since there are several lists that get notified of commits, and they're for everyone interested, not only committers.
- The SVN mailing lists should be removed and the equivalent lists for git used instead.
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2022-04-19 01:11:42 UTC
Committer's Guide: refer to Phabricator wiki page
<https://github.com/freebsd/freebsd-doc/pull/69>

> I'll probably make this my opportunity to begin making proper 
> use of Phabricator (alongside GitHub) …
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2022-05-16 17:56:42 UTC
(In reply to Graham Perrin from comment #1)

⚙ D35224 Committer's Guide: refer to Phabricator wiki page
<https://reviews.freebsd.org/D35224>
Comment 3 Graham Perrin freebsd_committer freebsd_triage 2022-07-07 19:26:23 UTC
<https://docs.freebsd.org/en/articles/committers-guide/#admin>

Three linked texts lead nowhere: 

[git-getting-started-base-layout]
[git-getting-started-doc-layout]
[git-getting-started-ports-layout]
Comment 4 Philip Paeps freebsd_committer freebsd_triage 2022-07-08 06:31:03 UTC
Since you've got a doc commit bit now... :-)  Happy to review patches.
Comment 5 Graham Perrin freebsd_committer freebsd_triage 2022-07-10 14:12:32 UTC
<https://docs.freebsd.org/en/articles/committers-guide/#_daily_use> describes git.freebsd.org as official mirrors. 

I'm aware of GitHub and GitLab as mirrors. 

Is git.freebsd.org also a mirror?
Comment 6 Graham Perrin freebsd_committer freebsd_triage 2022-07-10 14:23:15 UTC
> … gitrepo.freebsd.org will be canonicalized to repo.freebsd.org 
> in the future. …

Is that now the _past_?

ping -c 1 -4 repo.freebsd.org && ping -c 1 -4 gitrepo.freebsd.org

* both responses are from 96.47.72.44

ping -c 1 -6 repo.freebsd.org && ping -c 1 -6 gitrepo.freebsd.org

* both responses are from 2610:1c1:1:6068::e6a:5
Comment 7 Graham Perrin freebsd_committer freebsd_triage 2022-07-10 14:35:03 UTC
<https://github.com/freebsd/freebsd-doc/commit/bcbdcf52ce6535afa5da0cb48b1575ab8d071990#diff-28bd6e878c46180f486bf35004b04f85b2cae0519446044ab404f3688090e307R388>

> … For browsing internal/admin branch on web: 
> https://cgit.freebsd.org/${repo}/log/?h=internal/admin

Maybe better to present the URL as code, not a link, because it's not a valid URL until after the reader manually changes the URL.
Comment 8 Philip Paeps freebsd_committer freebsd_triage 2022-07-11 02:36:21 UTC
All Git repositories are technically mirrors of each other.  We call git.FreeBSD.org a mirror to distinguish it from the primary source of truth, which is repo.FreeBSD.org.

You are correct that the future is now.  We canonicalised gitrepo.FreeBSD.org to repo.FreeBSD.org when we finished the migration to Git.

Thanks for loving this article.
Comment 9 Pau Amma 2022-07-22 01:29:04 UTC
NTS:
- in new committer step 7, "AboutWiki Page" should link to https://wiki.freebsd.org/Wiki/About
- in new committer step 8, add https://wiki.freebsd.org/Community/Cats
- in new committer step 9, mention that's both ports and src
Comment 10 Pau Amma 2022-07-22 02:39:53 UTC
Make clear that committers automagically get a Bugzilla account created as part of onboarding step 6. Come to think of it, should the whole Kerberos section be merged into that step? Opinions welcome.
Comment 11 Pau Amma 2022-07-22 02:43:35 UTC
In 2.1 step 2, is "2048-bit keys with a three-year expiration provide adequate protection at present (2013-12)." still true in 2022-7?
Comment 12 Philip Paeps freebsd_committer freebsd_triage 2022-07-22 03:38:55 UTC
(In reply to PauAmma from comment #10)

I think it would be worth trying to change the way the committers guide is currently broken into sections.  Some of the current sections don't make a lot of sense.  Perhaps the guide should even be split up into multiple articles.


(In reply to PauAmma from comment #11)

2048 bit keys with expiration dates three years in the future still provide an adequate security margin, as far as I'm aware.  Adoption of ed25519 keys seems to be increasing.  These keys are smaller and generate smaller signatures.
Comment 13 Graham Perrin freebsd_committer freebsd_triage 2022-07-22 06:35:06 UTC
(In reply to PauAmma from comment #10)

> … a Bugzilla account created as part of onboarding step 6. …

Is that what happens? 

Or is Bugzilla (more simply) preset to use a central authentication server, in addition to local accounts?
Comment 14 Philip Paeps freebsd_committer freebsd_triage 2022-07-22 06:38:47 UTC
Bugzilla authenticates against Kerberos.  I believe something synchronises accounts from LDAP automatically, but I've been careful not to look too closely. :)  There may be a manual syncing step.
Comment 15 Pau Amma 2022-07-26 03:17:30 UTC
(In reply to Graham Perrin from comment #13)
I'm not sure there's a way to tell the difference without looking at the machinery with the attendant SAN loss, and it probably doesn't matter anyway. As a result of step 6, a new committer will have a separate Bugzilla login using their @f.o email address.
Comment 16 Pau Amma 2022-10-22 04:18:52 UTC
(In reply to Philip Paeps from comment #12)
> I think it would be worth trying to change the way the committers guide is
> currently broken into sections.  Some of the current sections don't make a lot of
> sense.  Perhaps the guide should even be split up into multiple articles.

Calling that one out of scope. Undecided about just merging the Kerberos section.
Comment 17 Pau Amma 2022-10-22 18:29:41 UTC
(In reply to Pau Amma from comment #0)
Not doing the first item in Who’s Who since that macro is used in several other places.
(In reply to Graham Perrin from comment #3)
Removing them as I can't figure out where they're supposed to point.
(In reply to Graham Perrin from comment #6)
Done here and in another spot.
(In reply to Graham Perrin from comment #7)
Done.
(In reply to Pau Amma from comment #9)
Not sure what I meant about step 9, not done.
(In reply to Pau Amma from comment #10)
Didn't merge the Kerberos section.
(In reply to Philip Paeps from comment #12)
Bumped the date on the key length sentence. Left the URL there although something more current (selected by someone who understands those things, meaning not me) would be better.
Comment 18 Graham Perrin freebsd_committer freebsd_triage 2023-01-04 01:11:06 UTC
A commit references this bug report: 

<https://cgit.freebsd.org/doc/commit/?id=63894dffe8ed65c9dc705959bc07c8a62991007d>

> Miscellaneous small changes to the Committer's Guide.
Comment 19 Pau Amma 2023-01-04 01:26:39 UTC
(In reply to Graham Perrin from comment #18)

Uh. Not sure why the hook or whatever it is didn't say that.
Comment 20 Li-Wen Hsu freebsd_committer freebsd_triage 2023-01-04 05:59:38 UTC
(In reply to Pau Amma from comment #19)
Because bug236229 has not been deployed yet.
Comment 21 Pau Amma 2023-01-04 13:19:55 UTC
(In reply to Li-Wen Hsu from comment #20)

Oops. Thanks.

(In reply to Graham Perrin from comment #18)

Thanks for the nudge.