Re: [Ispman-docs] ISPMan Handbook - First Draft

[Tony W. <wa...@az...>]

> Wil Cooley wrote:
>> I would propose embedding the CLI and API docs as POD and automatically
>> generating them.
>
> Hi Wil,
>
> I am all for having the POD documentation about the usage.
>
> The documentation I propose is a step by step guide on using the CLI.
>
> Example:
>
> Install ISPMan
> Add a reseller
> Add a client under the reseller
> Add a domain
> Set the client and reseller for the domain
> List domains
> Add a user in the domain
> Add a website in the domain
> List users/websites for the domain
>
> Manipulate DNS information for the domain
> Manipulate site-wide DNS information (very undocumented and powerful
> feature)
>
> etc
>
> best regards

Greetings!

Splitting out the CLI information to a different document makes sense.
Many users are only interested in getting it running and then using the
web interface(s). However, some of us want a deeper understanding of the
CLI.

We could include the POD documentation along with the above "Task
Oriented" information.

Tony