[OpenAFS-devel] "openafs" man page

[Russ Allbery]

Jeffrey Altman <jaltman@secure-endpoints.com> writes:

> The rationale for this being part of the Reference Manual (aka manpages
> on Unix) is that this document is installed on all systems and published
> on the web site.

> If there is consensus that using a man page would be inappropriate,
> I am not opposed to generating a new document.   Looking at the
> contents of some /usr/doc/<project>/ directories, I often see
> separate text only files for AUTHORS, CHANGELOG, COPYING or LICENSE,
> INSTALL, NEWS, README, etc.  We could certainly do the same or install
> .html and .pdf versions of the documentation files which could include
> the same contents.

I have tools to convert a well-formatted text file to HTML that I use for
all of my web pages, including handling of documents like this.  I can get
something like that working for OpenAFS as well.

> We have tried to maintain the contributors list on
> openafs.org/credits.html.  This is however a very manual process.
> Note that the web site is now maintained in git.  Any contributor
> that notices they are not on the credits.html is welcome to submit
> a patchset to correct the oversight.

> We might also want to add a link to

>   https://www.ohloh.net/p/openafs/contributors

> which generates a list from the Git repository contents.

I like that idea a lot.

-- 
Russ Allbery (rra@stanford.edu)             <http://www.eyrie.org/~eagle/>