Feature: Add reference guide / cheat sheet to the existing packaging guide docs
I have completed a couple cycles of the packaging guide locally (tested through the test PyPI step and reviewed the remaining steps). As part of this process, I created a reference guide for myself that contains the necessary steps to complete the full process (through the upload to and install from conda-forge steps), in a condensed format. Wanted to see if this is something that would be useful for the larger community.
My idea is to turn this reference guide into a nicely formatted doc, comparable to the conda cheat sheet, though not in PDF form, but to match the structure of the existing pyOpenSci docs. I have a repo with this information (full repo, reference guide contained in the README). The formatting is VERY rough at this time, but the content is all there.
My thought is that this could be useful for anyone who is new to the pyOpenSci packaging process and/or to Python packaging in general, as well as folks who would return to the document periodically for a quick reference on a specific part of the process.
I am happy to work on the issue myself. I can fork/clone/build-local as necessary and work with anyone from the team to refine the content and structure so that it would add value to the existing docs.
Thank you for your consideration of my suggestion.
hey there @calekochenour !! what a nice surprise to see you here 👋 i'm just dropping in to say that i've seen this issue and i / we agree it's a great idea!! if you want to work on this - please do!! and we will happily add it to the guide and credit you for your work as well. if you have any questions please just say the word. pr's are always welcome here!
Hey @lwasser ! Thanks for the note. Haven't been active on GitHub for a bit, but I am trying to get back into it. I recently discovered pyOpenSci, and I really like this package guide. I am working on the first iteration of the cheat sheet - just forked the repo yesterday, and I will certainly be submitting a PR at some point in the future. I will let you know if I have questions; currently going through the doc files to see how everything is set up at the moment. Thanks again!