From nobody Wed Feb 16 12:06:32 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 7AFCB19B6F33 for ; Wed, 16 Feb 2022 12:06:32 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4JzGs42zF2z3Gct; Wed, 16 Feb 2022 12:06:32 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1645013192; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=k90vpgcFRKkm7vULomVoROVq4BW6t1iHC+bpcUNkQ9g=; b=jXvIJrbi4KhaFydKuv/TkRJSX5RDXR1VXlGq649MnhwxMZwGNwJtIYCgl7WtzUW+9UG7Z6 2bWCO1SFB0so32HsSuLHM8fV9tTVZ/8ZMUWMTDZEj5dWKDDbI1tGDya/Qzj2C5Y3YLmlP3 3KP81/mwK4pqu0JlgfLAcB6DElXAvTEslHiUhDNZg3Rn6PjJBHqHdByyZY7zIANzc2Q/n9 tym5Nje1rsIBg3rpEL36VUs4kPOvSE1x2sqMHsm2MQYyfimPG1QTw7TNxFRN8WAUm49hcb T4Pin0XNbeNkbItcwROqINAh6Ho98JGIOPnZc+YLZo5WxN2Qz+msIKPwx+7GYg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 414B915DBB; Wed, 16 Feb 2022 12:06:32 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 21GC6WSI081932; Wed, 16 Feb 2022 12:06:32 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 21GC6Waw081931; Wed, 16 Feb 2022 12:06:32 GMT (envelope-from git) Date: Wed, 16 Feb 2022 12:06:32 GMT Message-Id: <202202161206.21GC6Waw081931@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Edward Tomasz Napierala Subject: git: aba783726c - main - handbook: Misc fixes to Introduction chapter List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: trasz X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: aba783726c3db451484d8d46cc027d60f009b6b9 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1645013192; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=k90vpgcFRKkm7vULomVoROVq4BW6t1iHC+bpcUNkQ9g=; b=f1ii3YtheS3PEvp3OyYML5XvEMj3UhuLbFZhkszNQMHAIfASdq4v9z0E0s6/H1bcmUFTkb HTNhKFxckp4/Ik/3/PIHctEk4GuVff6t32Z5/A2TfZ91Pqof8BH3kv+/Q8NRlSNCUpFx7j kyVM4qNax153bBtPHYcziZI5bvM7oEa0cqWswGxeyHvpaSka03JD3G5LxObo2GpQ7Ugrxs DiyLQMhSdipHouEgNGaOL4O19DSk8HOJEm99EBEIwdzo1sT4yXtAbGrRkEI7xf7fpd+P73 fhsg54jFz92DRrOjmfV0hmglSOkaComD/VsWLk7KS87Q6JoBKe4eCiDOiITI3Q== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1645013192; a=rsa-sha256; cv=none; b=VZTc1/ga8zut7tyR1VkBdy0uYHK/D56xsEr3O0GWvi1vnArWSnj4s8IFKuJ4Tlxpzyv8+7 BCOXqcHWox0p2GJwPRIXXON0TW3SQxwgISLpGfVWYiO+6eoMCeqTuN2BnZMIS73nrxI6KV B+D5JKnOnFCpvyKx4CQt7fJSh5QS+P8jyoDblQecYoMtNfpsnvRSO6lW6oAyAN4Pns1xNq 6HV6rGCt48VHxc4YVUg1yvdKzfEf4Y8Ea8XqEv/jUE89zt97s/dg17gsRTvlnIBhFL8pEQ 0xaG48FK3zhh3bkAKu5jCwwrJLoxXmt1kDoisnaPN5W8U/QWhaou6bETFdmKEA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by trasz: URL: https://cgit.FreeBSD.org/doc/commit/?id=aba783726c3db451484d8d46cc027d60f009b6b9 commit aba783726c3db451484d8d46cc027d60f009b6b9 Author: Edward Tomasz Napierala AuthorDate: 2022-02-12 23:13:36 +0000 Commit: Edward Tomasz Napierala CommitDate: 2022-02-12 23:13:40 +0000 handbook: Misc fixes to Introduction chapter This improves wording in many places, adds links to {dev-model} and {contributing}, and makes it more clear that we don't look just for C developers. Most of those fixes were contributed by Pau. Reviewed By: debdrup, Pau Amma Differential Revision: https://reviews.freebsd.org/D34100 --- .../en/books/handbook/introduction/_index.adoc | 38 ++++++++++++---------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/documentation/content/en/books/handbook/introduction/_index.adoc b/documentation/content/en/books/handbook/introduction/_index.adoc index 877636db9e..329d6bad1d 100644 --- a/documentation/content/en/books/handbook/introduction/_index.adoc +++ b/documentation/content/en/books/handbook/introduction/_index.adoc @@ -125,7 +125,7 @@ Many of the world's largest IT companies use FreeBSD: * link:https://www.emc.com/isilon[Dell EMC Isilon] - Isilon's enterprise storage appliances are based on FreeBSD. The extremely liberal FreeBSD license allowed Isilon to integrate their intellectual property throughout the kernel and focus on building their product instead of an operating system. * link:http://www.quest.com/KACE[Quest KACE] - The KACE system management appliances run FreeBSD because of its reliability, scalability, and the community that supports its continued development. * link:http://www.ixsystems.com/[iXsystems] - The TrueNAS line of unified storage appliances is based on FreeBSD. -* link:http://www.juniper.net/[Juniper] - The JunOS operating system that powers all Juniper networking gear (including routers, switches, security, and networking appliances) is based on FreeBSD. Juniper is one of many vendors that showcases the symbiotic relationship between the project and vendors of commercial products. Improvements generated at Juniper are upstreamed into FreeBSD to reduce the complexity of integrating new features from FreeBSD back into JunOS in the future. +* link:http://www.juniper.net/[Juniper] - The JunOS operating system that powers all Juniper networking gear (including routers, switches, and security and networking appliances) is based on FreeBSD. Juniper is one of many vendors that showcases the symbiotic relationship between the project and vendors of commercial products. Improvements generated at Juniper are upstreamed into FreeBSD to reduce the complexity of integrating new features from FreeBSD back into JunOS in the future. * link:http://www.mcafee.com/[McAfee] - SecurOS, the basis of McAfee enterprise firewall products including Sidewinder is based on FreeBSD. * link:http://www.netapp.com/[NetApp] - The Data ONTAP GX line of storage appliances are based on FreeBSD. In addition, NetApp has contributed back many features, including the new BSD licensed hypervisor, bhyve. * link:http://www.netflix.com/[Netflix] - The OpenConnect appliance that Netflix uses to stream movies to its customers is based on FreeBSD. Netflix has made extensive contributions to the codebase and works to maintain a zero delta from mainline FreeBSD. Netflix OpenConnect appliances are responsible for delivering more than 32% of all Internet traffic in North America. @@ -141,14 +141,14 @@ Many of the world's largest IT companies use FreeBSD: FreeBSD has also spawned a number of related open source projects: -* link:http://bsdrp.net/[BSD Router] - A FreeBSD based replacement for large enterprise routers designed to run on standard PC hardware. +* link:http://bsdrp.net/[BSD Router] - A FreeBSD based replacement for large enterprise routers, designed to run on standard PC hardware. * link:https://www.truenas.com/[TrueNAS] is a Network Attached Storage (NAS) software that shares and protects data from modern-day threats like ransomware and malware. TrueNAS makes it easy for users and client devices to access shared data through virtually any sharing protocol. -* link:https://ghostbsd.org/[GhostBSD] - is derived from FreeBSD, uses the GTK environment to provide a beautiful looks and comfortable experience on the modern BSD platform offering a natural and native UNIX(R) work environment. +* link:https://ghostbsd.org/[GhostBSD] is derived from FreeBSD, uses the GTK environment to provide a beautiful look and comfortable experience on the modern BSD platform offering a natural and native UNIX(R) work environment. * link:http://mfsbsd.vx.sk/[mfsBSD] - A toolkit for building a FreeBSD system image that runs entirely from memory. * link:https://xigmanas.com/[XigmaNAS] - A file server distribution based on FreeBSD with a PHP powered web interface. -* link:http://www.opnsense.org/[OPNSense] - OPNsense is an open source, easy-to-use and easy-to-build FreeBSD based firewall and routing platform. OPNsense includes most of the features available in expensive commercial firewalls, and more in many cases. It brings the rich feature set of commercial offerings with the benefits of open and verifiable sources. -* link:https://www.midnightbsd.org[MidnightBSD] - is a FreeBSD derived operating system developed with desktop users in mind. It includes all the software you'd expect for your daily tasks: mail, web browsing, word processing, gaming, and much more. -* link:https://www.nomadbsd.org[NomadBSD] - is a persistent live system for USB flash drives, based on FreeBSD. Together with automatic hardware detection and setup, it is configured to be used as a desktop system that works out of the box, but can also be used for data recovery, for educational purposes, or to test FreeBSD's hardware compatibility. +* link:http://www.opnsense.org/[OPNSense] is an open source, easy-to-use and easy-to-build FreeBSD based firewall and routing platform. OPNsense includes most of the features available in expensive commercial firewalls, and more in many cases. It brings the rich feature set of commercial offerings with the benefits of open and verifiable sources. +* link:https://www.midnightbsd.org[MidnightBSD] is a FreeBSD derived operating system developed with desktop users in mind. It includes all the software you'd expect for your daily tasks: mail, web browsing, word processing, gaming, and much more. +* link:https://www.nomadbsd.org[NomadBSD] is a persistent live system for USB flash drives, based on FreeBSD. Together with automatic hardware detection and setup, it is configured to be used as a desktop system that works out of the box, but can also be used for data recovery, for educational purposes, or to test FreeBSD's hardware compatibility. * link:http://www.pfsense.org/[pfSense] - A firewall distribution based on FreeBSD with a huge array of features and extensive IPv6 support. * link:http://zrouter.org/[ZRouter] - An open source alternative firmware for embedded devices based on FreeBSD. Designed to replace the proprietary firmware on off-the-shelf routers. @@ -210,10 +210,9 @@ Due to the additional complexities that can evolve in the commercial use of GPL [[development]] === The FreeBSD Development Model -The development of FreeBSD is a very open and flexible process, being literally built from the contributions of thousands of people around the world, as can be seen from our extref:{contributors}[list of contributors]. -FreeBSD's development infrastructure allow these thousands of contributors to collaborate over the Internet. -We are constantly on the lookout for new developers and ideas, and those interested in becoming more closely involved with the project need simply contact us at the link:{freebsd-hackers}. -The link:{freebsd-announce} is also available to those wishing to make other FreeBSD users aware of major areas of work. +The development of FreeBSD is a extref:{dev-model}[very open and flexible process], being literally built from the contributions of thousands of people around the world, as can be seen from our extref:{contributors}[list of contributors]. +FreeBSD's development infrastructure allows these thousands of contributors to collaborate over the Internet. +We are constantly on the lookout for new volunteers, and those interested in becoming more closely involved should consult the article on extref:{contributing}[Contributing to FreeBSD]. Useful things to know about the FreeBSD Project and its development process, whether working independently or in close cooperation: @@ -253,15 +252,17 @@ The Foundation also represents the FreeBSD Project in executing contracts, licen Outside contributors:: Last, but definitely not least, the largest group of developers are the users themselves who provide feedback and bug fixes to us on an almost constant basis. -The primary way of keeping in touch with FreeBSD's more non-centralized development is to subscribe to the link:{freebsd-hackers} where such things are discussed. +The primary way of keeping in touch with development of FreeBSD base system is to subscribe to the {freebsd-hackers} where such things are discussed. +For porting third party applications, it would be the {freebsd-ports}. +For documentation - {freebsd-doc}. See crossref:eresources[eresources, Resources on the Internet] for more information about the various FreeBSD mailing lists. + -extref:{contributors}[The FreeBSD Contributors List] is a long and growing one, so why not join it by contributing something back to FreeBSD today? -+ -Providing code is not the only way of contributing to the project; for a more complete list of things that need doing, please refer to the link:https://www.FreeBSD.org/[FreeBSD Project web site]. +extref:{contributors}[The FreeBSD Contributors List] is a long and growing one, so why not join it by extref:{contributing}[contributing something back to FreeBSD] today? +Providing code is not the only way! In summary, our development model is organized as a loose set of concentric circles. -The centralized model is designed for the convenience of the _users_ of FreeBSD, who are provided with an easy way of tracking one central code base, not to keep potential contributors out! Our desire is to present a stable operating system with a large set of coherent crossref:ports[ports,application programs] that the users can easily install and use - this model works very well in accomplishing that. +The centralized model is designed for the convenience of the _users_ of FreeBSD, who are provided with an easy way of tracking one central code base, not to keep potential contributors out! +Our desire is to present a stable operating system with a large set of coherent crossref:ports[ports,application programs] that the users can easily install and use - this model works very well in accomplishing that. All we ask of those who would join us as FreeBSD developers is some of the same dedication its current people have to its continued success! @@ -269,10 +270,11 @@ All we ask of those who would join us as FreeBSD developers is some of the same === Third Party Programs In addition to the base distributions, FreeBSD offers a ported software collection with thousands of commonly sought-after programs. -At the time of this writing, there were over {numports} ports! The list of ports ranges from http servers, to games, languages, editors, and almost everything in between. -The entire Ports Collection requires approximately {ports-size}. +The list of ports ranges from HTTP servers, to games, languages, editors, and almost everything in between. +There are about {numports} ports; the entire Ports Collection requires approximately {ports-size}. To compile a port, you simply change to the directory of the program you wish to install, type `make install`, and let the system do the rest. The full original distribution for each port you build is retrieved dynamically so you need only enough disk space to build the ports you want. + Almost every port is also provided as a pre-compiled "package", which can be installed with a simple command (`pkg install`) by those who do not wish to compile their own ports from source. More information on packages and ports can be found in crossref:ports[ports,Installing Applications: Packages and Ports]. @@ -295,4 +297,4 @@ The FreeBSD Handbook:: The FreeBSD FAQ:: [.filename]#link:file://localhost/usr/local/share/doc/freebsd/en/books/faq/book.html[/usr/local/share/doc/freebsd/en/books/faq/book.html]# -You can always find the up to date copy at link:https://docs.FreeBSD.org/[https://docs.FreeBSD.org/]. +You can always find up to date documentation at link:https://docs.FreeBSD.org/[https://docs.FreeBSD.org/].