-
Notifications
You must be signed in to change notification settings - Fork 59
Add command line reference guide to the Tutorials page #211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add command line reference guide to the Tutorials page #211
Conversation
@calekochenour thank you for this!! just a note that i have seen it and i'll put it on my todo list to review in the upcoming week!! |
@all-contributors please add @calekochenour for code, review |
I've put up a pull request to add @calekochenour! 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice work on this @calekochenour i'm going to share this in our slack with the community! you are also welcome to join our slack if you want. email me if that is of interest leah at pyopensci.org
@lwasser Thanks for the review and comments. I will address them soonest. I did test this on Windows, so some of the commands are OS-specific. The example commands at the moment reflect what I actually tested, except for the upload to Conda-forge. Happy to add more for various operating systems, pip vs. pipx, as well as your other comments. |
@JacksonBurns Thanks for your comments as well. I will address these soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good. A few suggestions on one section.
hey friends! just checking in. what do we need to do to get this merged? i thijnk from my perspective @calekochenour we can just be super specific about the windows commands (telling users this is for windows) and then we can go back in a separate PR and add mac/linux commands later! if that is the case then i think the changes would be mostly focused on headers or section text that specify "windows" and then maybe a note that says we will be updating this with mac/linux commands in the future. let me know what you think! |
@lwasser Thanks for the ping on this. I have not forgotten. I will look to make the updates/changes soonest. What you suggested in your latest comment makes sense to me. |
@lwasser @JacksonBurns @willingc I have addressed all comments with my latest commits. Please let me know if there are any outstanding issues and/or any comments that I have missed. Thanks in advance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks great! Thanks for taking my notes into account.
I'll need to troubleshoot why this is not building. I tried to fix the merge conflict. |
I just reran CI. Update: I fixed the CI warning. I will rerun CI again in a bit to fix the flaky htmlproofer error. Thanks for the updates @calekochenour. |
@lwasser @JacksonBurns If you can approve this PR, we can merge as the CI errors are now resolved 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It won't let me press approve, but I do approve haha
Hi everyone! I am officially becoming a blocker on our repos. My goal is to unblock. @JacksonBurns, I just invited you to our organization and added you to this repo so you can approve PRs and triage if you wish! Given we have two approvals, I will merge this pr now. @calekochenour I'm sorry this has taken so long to merge. I'm trying to set up structures so that I'm not a blocker on PRs - it is just taking time! I can no longer review everything because we have so many people contributing which is awesome! |
@lwasser thanks! Just accepted. |
Closes #202
This PR adds a reference guide for the commands used throughout the package creation process. The commands are grouped into four categories:
Adds a new section to the Tutorials page and a corresponding grid to the landing page. See screenshots for a preview from my local docs build.