Page MenuHomeFreeBSD

[fdp]New FDP Primer workflow chapter and related updates
Needs ReviewPublic

Authored by jpb_jimby.name on Oct 22 2024, 12:13 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Jan 11, 4:29 PM
Unknown Object (File)
Thu, Dec 26, 5:56 PM
Unknown Object (File)
Dec 4 2024, 1:47 PM
Unknown Object (File)
Dec 4 2024, 5:19 AM
Unknown Object (File)
Dec 4 2024, 5:19 AM
Unknown Object (File)
Dec 4 2024, 5:19 AM
Unknown Object (File)
Dec 4 2024, 4:56 AM
Unknown Object (File)
Nov 16 2024, 2:29 PM

Details

Reviewers
None
Group Reviewers
docs
manpages
doceng

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 60139
Build 57023: arc lint + arc unit

Event Timeline

jpb_jimby.name created this revision.

I'll look at the screenshots and diagrams later. I don't want to defer this installment any further.

documentation/content/en/books/fdp-primer/workflow/_index.adoc
83

Spurious space.

98

I'd make that a link to the "working copy" chapter.

107
110
111

Somewhere in this paragraph, I'd mention that if you specify docs as a group reviewer, members of docs on Phabricator (which should be most Doc Team members if not all) get an email notice of the review.

documentation/content/en/books/fdp-primer/working-copy/_index.adoc
57

What is your rationale for this change?

136
137

Is it worth linking to https://sethrobertson.github.io/GitFixUm/fixup.html here or in the resources section?

145
157–166

IIRC, after using "git add", you need to use "git diff --staged". Plain "git diff" will return an empty diff, confusing everyone involved. Or move the "git add" to just before "git commit" in the workflow that needs a commit.

172

Since you're touching this line: this is no longer needed. Instead, the patch contributor should check the "attachment is patch" box in the web interface when uploading the patch.

204
209
271

Not necessarily the reviewer - it can be the submitter themselves.

278
335
339
352
378
519

This looks out of place here. Shouldn't it be after the last line of this change, starting with

The differential is immediately available for inspection

?

These updates include some extra content in 4.7 "Making a Diff to Submit to Bugzilla".

documentation/content/en/books/fdp-primer/working-copy/_index.adoc
57

The link to https://git-scm.com takes the reader off the FreeBSD ecosystem to the git homepage which does not give the reader access to much useful information. The link to the git man page provides immediate useful information that is FreeBSD specific.

The link package:devel/git[] takes the reader to the useless index page for the git port which has no information about how to install the port or package.

I've opted for the revised text which keeps the reader focused on the doc tool set.

137

Both places.

157–166

This is existing content. I was trying to apply just the minimum changes.

I've added "git diff --staged" text as you suggested.

jpb_jimby.name marked 3 inline comments as done.

[fdp]New FDP Primer workflow chapter and related updates

[fdp]New FDP Primer workflow chapter and related updates

Updated hrefs, minor typo and style changes.

Thank you so much for your changes.
I'm gonna make a review and if everything it's ok I'll make the commit :)