commissaire icon indicating copy to clipboard operation
commissaire copied to clipboard
verified publisher icon projectatomic

Update Documentation Based On TODO's

Open ashcrow opened this issue 9 years ago • 5 comments

Our documentation has a number of TODO's defined that need to be addressed. This includes wordsmithing areas that flow awkwardly.

ashcrow avatar Oct 18 '16 19:10 ashcrow

I do like to write, but I am not sure if it is good enough to be used for general documentation. Anyways, I could propose some changes and otherwise discuss them on the Atomic mailinglist.

gbraad avatar Oct 19 '16 03:10 gbraad

@gbraad that sounds great!

ashcrow avatar Oct 19 '16 12:10 ashcrow

Haven't been able to start this yet, but one of the other topics that needs to be documented is the Authentication plugins and manager. Especially after https://github.com/projectatomic/commissaire-http/issues/33 has been merged, as it changes the available options significantly.

gbraad avatar Nov 01 '16 06:11 gbraad

@gbraad no rush. Thanks for updating the issue!

ashcrow avatar Nov 01 '16 13:11 ashcrow

I ended up doing some of this work in eeafc34e4cf7c9a0d824d0a460de9cb8fb54c53c. It still needs restructuring.

ashcrow avatar Feb 28 '17 12:02 ashcrow