Bug 254132 - handbook needs to be updated with links to new git methods of updating src and ports and docs
Summary: handbook needs to be updated with links to new git methods of updating src an...
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Website (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Sergio Carlavilla Delgado
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-03-08 12:02 UTC by tech-lists
Modified: 2021-03-14 17:30 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description tech-lists 2021-03-08 12:02:25 UTC
Hello,

Currently, in the handbook, there is no link to the ongoing work-in-progress new method of updating src or ports or docs using git. For example, there could be a note placed in https://docs.freebsd.org/en/books/handbook/cutting-edge/ to the effect of "the method of updating via svn is legacy and the new methods described in this WIP https://github.com/bsdimp/freebsd-git-docs#readme should be used if upgrading from at least 13-stable (or, previously, 13-current)

I'd make the amendment myself but I don't know the new method (yet) of updating docs, which I understand from various mailing lists, has moved over to git, markdown and hugo.
Comment 1 commit-hook freebsd_committer freebsd_triage 2021-03-14 17:09:15 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=2a617095b169521d726a3db843e3927c82eb9330

commit 2a617095b169521d726a3db843e3927c82eb9330
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2021-03-14 17:06:17 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2021-03-14 17:06:17 +0000

    Upgrade informacion about the new git procedures.

    Upgrade some information about the new git procedures
    in cutting-edge chapter.

    Upgrade the bsd family tree to point to git instead of svn

    PR:             254132
    Submitted by:   tech-lists (at) zyxst.net

 .../en/books/handbook/bibliography/_index.adoc     |   5 +-
 .../en/books/handbook/cutting-edge/_index.adoc     | 510 ++++++++++++---------
 .../content/en/books/handbook/mirrors/_index.adoc  |  18 +-
 3 files changed, 302 insertions(+), 231 deletions(-)
Comment 2 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2021-03-14 17:30:09 UTC
Fixed!

If you want to contribute to the documentation take a look to the FDP[1]
The new website and documentation portal use Hugo and AsciiDoc.

[1] https://docs.freebsd.org/en/books/fdp-primer/