Documenting new features

From SambaWiki
Revision as of 03:40, 13 September 2018 by Timbeale (talk | contribs) (WIP: how to document new samba features)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The best place to document Samba features is in the code itself, i.e. by writing great man-pages and samba-tool help. Writing a good WHATSNEW.txt description is also a great way to let existing Samba users know about a new feature. However, documenting new and updated features on the Samba wiki is also useful, and can be a helpful way for a new Samba user to work out what Samba can and cannot do.

There's a template to help you get started. Just create a new page and save it with the following content:

{{subst:NewFeature}}

Through the magic of mediawiki templating, this will create a skeleton page. Replace the <...> markers in each section with your own content.