Documentation - Githubissues

cobbler / cli

Independent CLI written in Go for the Cobbler server.

GNU General Public License v2.0

1 stars 4 forks source link

Documentation #20

Closed SchoolGuy closed 3 years ago

SchoolGuy commented 3 years ago

I desire to have the following forms of documentation:

In-Code Documentation: For all things related specifically related to the code seen at this moment. --> Well in code.
User Documentation: For all things related which users might find interesting. --> We are using Read the Docs lets use this here too.
Developer Documentation: Setup instructions, Guidelines, Pitfalls --> This goes into the GH Wiki of this repository.

This should be in a state when you finish your work here @nodeg that everyone who has never touched this project can continue.

Assumptions you may take:

Users: System Administrators that do know how to do a wget/curl and similar things.
Developers: Basic Go knowledge