Page MenuHomeFreeBSD

Convert the FDP primer from using svn to using git.
Needs ReviewPublic

Authored by pauamma_gundo.com on Jan 20 2021, 4:26 AM.

Details

Reviewers
bcr
debdrup
carlavilla
Group Reviewers
docs
Summary

Note that after "git mv working-copy local-clone" and editing
local-clone/chapter.xml, git seems to think they're unrelated files.
Sorry about that.

Test Plan

Commands tested by running them as part of the change itself.

Output tested with lynx.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 36356
Build 33245: arc lint + arc unit

Event Timeline

pauamma_gundo.com created this revision.

Have you checked with xmllint?

My initial impression is that this looks good apart from a few nits, but if at all possible I'd like to hear from others too.
To that end, I've reached out OOB and hope to hear back.

I'll also note that I've checked, and it builds fine.

en_US.ISO8859-1/books/fdp-primer/local-clone/chapter.xml
95–96

What prompted the use of pulls and merges being fast-forward only?

It's my understanding that to avoid merge commits (ie. the commits that say "Merge branch ..", rebase is to be used liberally both on branches before and after merging.

en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
273–274

is a.dev-commits-doc-all.url defined anywhere?

I can't seem to find it, and xmllint complains about it.

Haven't run it through xmllint or igor yet, I first wanted to get a substantive review on my first draft. I will do so before submitting a 2nd draft, although perhaps I should wait to hear from Carlavilla before doing that. What's their username here?

en_US.ISO8859-1/books/fdp-primer/local-clone/chapter.xml
95–96

https://github.com/bsdimp/freebsd-git-docs/blob/main/doc-cvt.md (which I used liberally throughout drafting this) and specifically the uses of that option under "Keeping current".

Did I misunderstand something?

en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
273–274

Courtesy of grep -r:

./en_US.ISO8859-1/share/xml/mailing-lists.ent:<!ENTITY a.dev-commits-doc-all.url "&a.mailman.listinfo;/dev-commits-doc-all">

debdrup added a subscriber: carlavilla.

Haven't run it through xmllint or igor yet, I first wanted to get a substantive review on my first draft. I will do so before submitting a 2nd draft, although perhaps I should wait to hear from Carlavilla before doing that. What's their username here?

@carlavilla is their username - I've also gone ahead and added them as a reviewer, just in case.

en_US.ISO8859-1/books/fdp-primer/local-clone/chapter.xml
95–96

Ah, no - that makes sense.
I wasn't aware that fast-forwarding also avoided those merge commits, but that's good to know. :)

en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
273–274

Welp, now I just feel foolish. :)

The problem here is not to convert this to AsciiDoctor, is how to fit all of these new content into the new FDP...

I'm going to propose something to you @pauamma_gundo.com

What do you think if we wait until the migration is complete and after that I'll convert all of this to AsciiDoctor and
we'll look how to add all of these information to the new FDP?
In this way you're not gonna lose of this work.

Apart of that, thanks for all your work in the documentation :)

What do you think if we wait until the migration is complete and after that I'll convert all of this to AsciiDoctor and
we'll look how to add all of these information to the new FDP?

That probably works better than my attempt to get it in at the last moment.

@pauamma_gundo.com after reading the whole patch. I think that the only part that we can use is the local-clone chapter.
I'm gonna convert it to AsciiDoc and send to you my email.

Please, can you send me an email? I don't have yours. carlavilla@FreeBSD.org