Documentation - What do you want changed/updated?

[daveformerlyof]

Just like the title says. What do you guys want to see changed in the documentation for WHM or cPanel? What other documentation do you want to be added or updated? Feel free to post any constructive suggestions.

[daveformerlyof]

Just like the title says. What do you guys want to see changed in the documentation for WHM or cPanel? What other documentation do you want to be added or updated? Feel free to post any constructive suggestions.

[richy]

Details of the cPanel "tags" (used in the cpanel/whm displays) would be nice.

[daveformerlyof]

API documentation is currently in progress. (There are a lot of API tags so it may take a while)

[timdorr]

I'd like to see it more task oriented, rather than option-oriented. Most of the time, when I've tried to consult it, it's not conducive to my method of looking for help. I'd like answers on how to do something, not an enumeration of the options on the system.

Take the MovableType documentation for example: http://www.sixapart.com/movabletype/docs/3.2/

It is based around common tasks and solutions for using the system. Similarly, if someone wants to do something in cPanel/WHM, they don't know which option to search for in the interface, so going through all the elements isn't going to help them. They can do that without the documentation. In addition, if something uses more than one section of the interface, they're not necessarily going to know to go to that other section to complete the operation. For example, if you want to set up alerts for when new accounts are set, you've gotta figure out both where you set your contact method (Edit Setup) and where you go to turn it on (Contact Manager).

I honestly believe having the documentation in that format and expanding it as certain common problems arise, will *signficantly* reduce your support load.

[ghv]

I'd like to see a comprehensive, frequently updated guide for /scripts

[BianchiDude]

Documentation on how to cluster my dns with 2 servers with cpanel

[chirpy]

Are you referring to DNS clustering? If you're referring to true clustering, then it's not currently possible to do with software alone (without a great deal of custom scripting) and so cannot be documented.

[BianchiDude]

I want too see an example of how to do my backups with a coda mount.

Backup Destination (this should be a dir/nfs/coda mount with at least twice the space of all your /home* partitions. Setting this to /home is a VERY BAD IDEA.):

[daveformerlyof]

I'd like to see it more task oriented, rather than option-oriented. Most of the time, when I've tried to consult it, it's not conducive to my method of looking for help. I'd like answers on how to do something, not an enumeration of the options on the system.

Take the MovableType documentation for example: http://www.sixapart.com/movabletype/docs/3.2/

It is based around common tasks and solutions for using the system. Similarly, if someone wants to do something in cPanel/WHM, they don't know which option to search for in the interface, so going through all the elements isn't going to help them. They can do that without the documentation. In addition, if something uses more than one section of the interface, they're not necessarily going to know to go to that other section to complete the operation. For example, if you want to set up alerts for when new accounts are set, you've gotta figure out both where you set your contact method (Edit Setup) and where you go to turn it on (Contact Manager).

I honestly believe having the documentation in that format and expanding it as certain common problems arise, will *signficantly* reduce your support load.

Have you tried using an index search or the search function for the tasks you wish to complete? The index is pretty complete and the search function is very good. Try searching for a few tasks you wish to complete.

We are also working on something right now that is task oriented, which you should see sometime in the near future.

[ghv]

"We are also working on something right now that is task oriented, which you should see sometime in the near future."


That would also be very good.

[21chosting]

I would love for cPanel and Urchin to work quickly and efficiently. Well I would like it to work first, then concentrate on speed and efficiency.

[daveformerlyof]

I would love for cPanel and Urchin to work quickly and efficiently. Well I would like it to work first, then concentrate on speed and efficiency.

Please keep this thread to ideas for documentation only. Feature requests/Bug Reports are handled elsewhere.

[timdorr]

Have you tried using an index search or the search function for the tasks you wish to complete? The index is pretty complete and the search function is very good. Try searching for a few tasks you wish to complete.

My particular example still fails with the use of the index. You're not going to know where to set up the contact email based on the current documentation. It's all very atomic and doesn't document how features interact with each other.

[BianchiDude]

I want too see an example of how to do my backups with a coda mount.

Backup Destination (this should be a dir/nfs/coda mount with at least twice the space of all your /home* partitions. Setting this to /home is a VERY BAD IDEA.):

DaveDark, what do you think of adding how to do the above to your documentation? Its a feature in whm, and it looks like a good one, and should be documented on how to do this, dont you agree?