univ-of-utah-marriott-library-apple / python-jamf

`python-jamf` is a library for connecting to a Jamf Server. It maps Jamf Pro records to a Record class. It is the basis for the `jctl` tool to automate patch management & packages and many other items.
MIT License
55 stars 16 forks source link

Turn README into wiki #12

Closed Honestpuck closed 3 years ago

Honestpuck commented 3 years ago

Not really an issue. Just a point I wanted to raise for discussion. The README is now getting to a length and if I add documentation for my work it will get longer.

So how do you feel about me taking the existing README and my documentation and turning it onto a shorter README and a wiki? I was thinking of just a top page and only one layer of sub pages corresponding with the current headlines.

I also have no idea if I can PR the wiki but I'm guessing I can.

Tophernad commented 3 years ago

Hey Tony, I think that is a great idea. Having a more detailed wiki is nice for bigger projects. I’m not sure how to merge a wiki but we can figure it out. Topher

Honestpuck commented 3 years ago

OK. I'll do it over the next few days while working on test_records.py.

Honestpuck commented 3 years ago

python-jamf.wiki.zip

Hey @Tophernad

You can't do a PR for the wiki so here is a first crack at it. Clone down the blank wiki, drop these in there and push back to GitHub.

Tophernad commented 3 years ago

The wiki has been updated with the info that you provided. The README needs to be updated to reflect that there is a Wiki now.