Documentation [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Documentation =====

==== Missing and lacking handbook sections ====

  * Examples need testing, some are outdated
    * Maybe need some more complicated ones?
  * bhyve section needs to document hardware requirements
  * Network tuning instructions
  * rctl (more examples for enterprises - daichi can help
  * NFSv4 chapter update, cover NFSv4.1?
  * HPC chapter
    * Fibre Channel
    * Infiniband
    * 10/40GbE
  * Installing the system without bsdinstall
    * Scripted
    * PXE
  * Jail chapter
    * path to jail
    * jail.conf
    * Installing jails with "bsdinstall jail"
  * Config managemnt (puppet, ansible, cfengine, etc)
  * Using %%FreeBSD%% in the cloud
    * Amazon EC2
    * Azure
    * Google Compute Engine
  * X11 chapter needs KMS documenting
  * %%VirtIO%%
  * Chapter on monitoring (vmstat, gstat, more dtrace, other tools in base for system monitoring)

==== Missing and lacking man pages ====

  * iSCSI - Needs documenting
  * bhyve - Man page lacks any info on hardware compatibility etc
  * vt - Needs a man page
  * tuning(7) - needs major updates.  sbruno offered to help
  * rctl - Needs more detail
  * IPv6 - Missing many examples, for example how to add a second address

==== Website issues/suggestions ====

  * Font (too small)
  * Info on "how to contribute/give back" needs to be easier to find
    * how to communicate with different groups
    * newbie guide
    * easier to find content
  * Docs on how to build only parts of the doc tree (e.g. not all languages)
  * Better search field (gavin)
  * Fix up man.cgi
    * Make the UI more user friendly
    * Default to newest version of man pages
    * Needs to get copies of man pages quicker
    * Man pages from all arches (install from all architectures?)