aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer
Commit message (Collapse)AuthorAgeFilesLines
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-2521-10404/+0
| | | | | | | | | | | | | | | | | | | | | | | | I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
* books/: Address more instances of sentences beginning with 'Because...'Ceri Davies2021-01-123-8/+8
| | | | | | | | | | | | | | As was the case with the previous commit, the intention is to avoid sentence fragments as well as sentences that can be mistaken for them, since the handbook isn't written in a style that makes use of subordinate conjunctions. While touching the relevant files, I also fixed a few issues pointed out by PauAmma, and reflowed a sentence as a result. PR: 252519 Submitted by: ceri@ Reviewed by: PauAmma
* [fdp-primer][manpages] Fix pluralFernando Apesteguía2020-12-121-1/+1
| | | | | | | | | s/backspaces/backspace/ Fix ill plural introduced in 59e3915e5ca57b7a1be87a01f909929d554d6626 Approved by: docs (gbe@, ygy@) Differential Revision: https://reviews.freebsd.org/D27537
* Add a Testing section for manpages in the FDP Primer.Guangyuan Yang2020-11-281-15/+43
| | | | | | | | | | | Move the relative information from the Tip section about testing manpages to the new section, along with information about mandoc(1)'s linter, igor, etc. It now covers quite a few cases and common mistakes. Submitted by: fernape Reviewed by: debdrup, ygy Differential Revision: https://reviews.freebsd.org/D27386 Notes: svn path=/head/; revision=54717
* Add optional fop install step to generate PDF output.Benedict Reuschling2020-06-152-0/+12
| | | | | | | | | | | | | | | | | | | The textproc/fop is an optional package that can be installed to generate PDF output of our docs. It is not included in textproc/docproj by default and if not strictly required, but for those who want PDFs we describe how. While here, bump the copyright dates of the FDP primer. Thanks to Pau Amma for this change. PR: 247019 Submitted by: pauamma_gundo.com Reviewed by: debdrup, allanjude Approved by: allanjude, bcr Differential Revision: https://reviews.freebsd.org/D25170 Notes: svn path=/head/; revision=54256
* To be consistent, add the missing comment for the Set_Highlights()Benedict Reuschling2020-03-161-1/+1
| | | | | | | | function after the endfunction just like it is done for the other functions and if statements shown. No functional change. Notes: svn path=/head/; revision=53987
* The example in section 6.2 uses DESTDIR to define where theBenedict Reuschling2019-11-031-4/+4
| | | | | | | | | | | | website build should end up in. However, it does not work with DESTDIR, but with DOCDIR. Change the example and description to use DOCDIR. PR: 241676 Submitted by: pauamma@gundo.com Notes: svn path=/head/; revision=53527
* TRANSLATOR option is currently enabled by default in textproc/docproj. ↵Guangyuan Yang2018-12-251-9/+3
| | | | | | | | | | Reword instructions to reflect this in PO Translation Quick Start. PR: 229539 Reported by: egypcio Notes: svn path=/head/; revision=52724
* Checkout URL clarified by gjb. Recorrected.Dru Lavigne2018-12-143-4/+4
| | | | | | | | Reported by: gjb Sponsored by: iXsystems Notes: svn path=/head/; revision=52692
* Checkout protocol is HTTP, not HTTPS.Dru Lavigne2018-12-143-4/+4
| | | | | | | | | Submitted by: dru Reported by: gjb Sponsored by: iXsystems Notes: svn path=/head/; revision=52691
* Update svn checkout URL in FDP.Dru Lavigne2018-12-143-4/+4
| | | | | | | | | | | | PR: 234018 Submitted by: dru Reported by: bcr Reviewed by: bcr Approved by: bcr Sponsored by: iXsystems Notes: svn path=/head/; revision=52690
* Remove documentation that recommends XEmacsJoseph Mingrone2018-11-302-8/+5
| | | | | | | | | | | It has been nearly a decade since the last stable release of XEmacs, and editors/xemacs was removed from the ports tree in 2014. Approved by: gjb Differential Revision: https://reviews.freebsd.org/D18383 Notes: svn path=/head/; revision=52526
* Wrap long lines, properly indent tags, capitalizations, and other fixes forBenedict Reuschling2018-08-178-73/+109
| | | | | | | issues that textproc/igor reported. Notes: svn path=/head/; revision=52151
* Apply proper wrapping and nesting of tags.Benedict Reuschling2018-08-171-6/+12
| | | | Notes: svn path=/head/; revision=52150
* Overlong lines are now properly wrapped to the proper length.Benedict Reuschling2018-08-171-5/+8
| | | | Notes: svn path=/head/; revision=52149
* Properly wrap line that were too long.Benedict Reuschling2018-08-171-26/+34
| | | | Notes: svn path=/head/; revision=52148
* Cleanup the translation section by rewrapping long lines.Benedict Reuschling2018-08-171-16/+23
| | | | | | | textproc/igor is happy now. Notes: svn path=/head/; revision=52147
* Example snippet uses invalid syntax which creates errors when used in a doc.Sevan Janiyan2018-08-111-6/+9
| | | | | | | | | | | | Fix spelling mistake while here. PR: 204893 Submitted by: Andreas Perstinger <andipersti at gmail> Approved by: bcr (mentor) rene Differential Revision: https://reviews.freebsd.org/D16680 Notes: svn path=/head/; revision=52103
* fdp-primer: remove non-existent translationsEitan Adler2018-08-091-16/+0
| | | | Notes: svn path=/head/; revision=52095
* Replace vim-lite with vim console, as the port was renamed.Benedict Reuschling2018-06-021-2/+3
| | | | | | | | | | Additionally, add vim-tiny as another vim-port that people can use. PR: 228449 Submitted by: 0mp@ Notes: svn path=/head/; revision=51766
* add xref to Subversion information to FDP primerSevan Janiyan2018-05-211-0/+4
| | | | | | | | | Submitted by: linimon Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D9251 Notes: svn path=/head/; revision=51682
* Add missing xml:id to sectx elements.Mathieu Arnold2018-04-176-28/+29
| | | | | | | Sponsored by: Absolight Notes: svn path=/head/; revision=51563
* Add a substeps example for the procedure.Mathieu Arnold2018-04-171-3/+19
| | | | | | | Sponsored by: Absolight Notes: svn path=/head/; revision=51560
* FDP: Reduce confusion with man'n' (correct fix)Eitan Adler2018-01-061-1/+2
| | | | | | | | | | | - A lowercase 'n' looks like 'mann'. Make this slightly easier to read. - While here, fix indent PR: 224958 Submitted by: Vitalio <v.dol_s@hotmail.com> Notes: svn path=/head/; revision=51370
* FDP: Reduce confusion with man'n'Eitan Adler2018-01-061-2/+2
| | | | | | | | | | | - A lowercase 'n' looks like 'mann'. Make this slightly easier to read. - While here, fix indent PR: 224958 Submitted by: Vitalio <v.dol_s@hotmail.com> Notes: svn path=/head/; revision=51369
* FDP Primer: add missing word; pet igorEitan Adler2017-12-231-9/+14
| | | | | | | | PR: 224531 Submitted by: ljuba.bsd@gmail.com Notes: svn path=/head/; revision=51332
* Add missing word.Warren Block2017-12-021-1/+1
| | | | | | | Sponsored by: iXsystems Notes: svn path=/head/; revision=51250
* switch to HTTPS for people.freebsd.orgWolfram Schneider2017-10-011-1/+1
| | | | Notes: svn path=/head/; revision=51012
* Whitespace-only fixes, translators please ignore.Warren Block2017-09-291-7/+7
| | | | | | | Sponsored by: iXsystems Notes: svn path=/head/; revision=51000
* First set of patches, from me.Warren Block2017-09-291-2/+2
| | | | | | | Sponsored by: iXsystems Notes: svn path=/head/; revision=50999
* Add an initial chapter about creating man pages. Much remains to beWarren Block2017-09-294-0/+725
| | | | | | | | | | | added, but at least there will be a place to add it. And of course there are bound to be numerous corrections, to which I say the quintessential BSD response: patches welcome! Sponsored by: iXsystems Notes: svn path=/head/; revision=50998
* switch to HTTPSWolfram Schneider2017-09-293-4/+4
| | | | Notes: svn path=/head/; revision=50966
* Subversion is not installed by textproc/docproj by default.Sevan Janiyan2017-08-192-6/+11
| | | | | | | | | | | | Direct reader to install the docproj package as well as the subversion package. From the BSDCam 2017 Doc hackday. Submitted by: Deb Goodkin <deb AT freebsdfoundation DOT org> Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D11807 Notes: svn path=/head/; revision=50695
* Bump copyright after r50479.Glen Barber2017-08-011-0/+3
| | | | | | | | | PR: 221150 Submitted by: deb Sponsored by: The FreeBSD Foundation Notes: svn path=/head/; revision=50614
* The instructions in the Quickstart section for submitting a diffBenedict Reuschling2017-07-121-12/+12
| | | | | | | | | | | | | | | | still listed gnats, which was replaced by Bugzilla a while ago. They were rewritten for Bugzilla and describe the steps to submit the patch via the webgui. I cleaned up the patch for whitespace, the original text is from the submitter. PR: 219899 Submitted by: Roller Angel (roller@rollercomsolutions.com) Sponsored by: BSDCan 2017 Doc lounge Notes: svn path=/head/; revision=50479
* Added return to "Hello World" example.Michael Dexter2017-06-101-0/+2
| | | | | | | Approved by: bcr (mentor) Notes: svn path=/head/; revision=50350
* Clarify nano customization.Warren Block2017-06-101-2/+3
| | | | | | | Submitted by: Tim Moore <timmoore88@gmail.com> Notes: svn path=/head/; revision=50349
* This experimental commit removes all $FreeBSD$ strings from the FDPWarren Block2017-06-0718-20/+2
| | | | | | | | | | | | | | Primer because these continually-changing strings interfere with PO translations. They text version in the file is also potentially inaccurate. The FreeBSD=%H property has also been removed from these files, although without $FreeBSD$ strings, it has no effect. The fbsd:nokeywords property has been set to "yes" to allow the commit. NO INFORMATION HAS BEEN LOST. The version control information is stored in the metadata and can be retrieved with 'svn info [file]'. Notes: svn path=/head/; revision=50331
* remove duplicate wordEitan Adler2017-01-091-1/+1
| | | | Notes: svn path=/head/; revision=49811
* - Update and simplify section on comments according to the XML standardGabor Kovesdan2016-09-081-37/+21
| | | | | | | | | | (this section still reflected some old SGML constructs). PR: 204885 Submitted by: Andreas Perstinger <andipersti@gmail.com> Notes: svn path=/head/; revision=49372
* Whitespace-only fixes, translators please ignore.Warren Block2016-08-051-6/+6
| | | | Notes: svn path=/head/; revision=49220
* Update Emacs section of editor configuration chapter in FDP Primer.Warren Block2016-08-051-4/+79
| | | | | | | | PR: 211184 Submitted by: Joseph Mingrone <jrm@ftfl.ca> Notes: svn path=/head/; revision=49219
* Update textproc/docbook-xml package origin in FDP primer Tools chapterEnji Cooper2016-06-111-1/+1
| | | | | | | | | The older package origin is no longer available in ports as of r345097 Reviewed by: dlavigne, wblock Notes: svn path=/head/; revision=48918
* Swap The FreeBSD Documentation Set and the Quick Start sections in theWarren Block2016-06-101-67/+67
| | | | | | | | Overview chapter, making the Quick Start section the first thing that eager new documentation contributors see. From BSDCan 2016 Doc Lounge. Notes: svn path=/head/; revision=48912
* Rework vim editor configuration section to be clearer.Warren Block2016-06-091-10/+12
| | | | | | | | | From BSDCan 2016 Doc lounge. Reported by: Chris Amos <spazmaticcelery@hotmail.com> Notes: svn path=/head/; revision=48905
* Add "userland" to the word list.Warren Block2016-03-281-0/+7
| | | | Notes: svn path=/head/; revision=48493
* Fix one instance of "document(s)" (please don't ever, ever, ever useWarren Block2016-02-271-1/+1
| | | | | | | that) and change passive/unsure "should be" to "are". Notes: svn path=/head/; revision=48279
* Fix tag markup for an image example. Pointed out by user laidback onWarren Block2016-02-261-1/+1
| | | | | | | IRC. Notes: svn path=/head/; revision=48267
* Update pkg_create(1) to pkg-create(8).Warren Block2016-02-201-1/+1
| | | | Notes: svn path=/head/; revision=48228
* Remove misplaced URL in DOCTYPE explanation.Warren Block2016-02-171-2/+1
| | | | | | | PR: 204884 Notes: svn path=/head/; revision=48188
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-27 02:35:46 +0000