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
Update Pinax Quick Start and pinax/pinax README with new pinax-cli way of starting projects #102
Comments
Hi! I'm the creator of twitter.com/yourfirstpr, a project that shares great starter issues with beginners to programming and open source. I just wanted to take the time to say wow, what an amazing and comprehensive issue! I think it the best I have seen so far and it makes me so happy. I'll be tweeting this Friday afternoon (1PM GMT!). Thank you again ✨ 💖 |
@Charlotteis Thank you for your kind words, Charlotte 😊 Could you please hold off until Friday evening? I scheduled some tweets about this from our Pinax project Twitter account which will go live around 5.45pm CET on Friday. Thank you! We're definitely planning on creating more issues like this one 😊 |
Unfortunately that will be 22.45PM which is far too late (no-one in the UK will see it) so I'll have to do it the Saturday morning. |
Sorry, I meant CET (I live in Germany), not EST so that should be 4.45pm UK time. If that's too late Saturday morning or sometime next week would work as well. Thanks again 😊 |
A little bit too late for the schedule (I usually do things at 1PM). But I will see what I can do, if not, I'll do it on Saturday or Monday :) Thanks again! |
Awesome, thank you 👍 |
Hi there! I'm brand new when it comes to making OSS contributions. This looks like a great way to get started. Thanks for posting it. I'm in the process of trying it out. Looks like the part of the issue dealing with README.md has already been addressed in a previous commit (364f8b0) I'm assuming it's ok to continue on with the other portions of the issue though. Also, I noticed that in docs/quick_start.md the startproject command uses an argument "-n webpack.config.js" whereas the corresponding line in README.md did not. I'm assuming this not an issue and the argument can simply be left off in the cli version of the command. Thanks again for posting this. I'm looking forward to sending a pull request! |
@ethankent thanks! yes, other parts are still relevant I think. One thing to note is that |
Thanks @paltman! Hopefully everything looks good in my pull request. |
Hi there! I think this issue is close-able. If you need anything else, please let me know :) |
Thanks @ethankent! |
Right now the Quick Start in the Pinax documentation and the README of this repository still show the "manual" way of starting Pinax starter projects. Since there's now an easier way to do that with the Pinax Command Line (pinax-cli) both of these documents need to be updated. We'd like to give someone who has never contributed to open source before a chance to tackle this task in order to make their first OSS contribution. If you have contributed to open source before, please let someone else take this one. Below you can find some guidelines and instructions on what you need to do:
pinax-cli
to installpinax-project-blog
.pinax/pinax
repository in your text editor and update the "Getting Started" section in theREADME.md
file with the newpinax-cli
way of starting projects. Don't forget to save your changes. Please note that we use Markdown syntax for our documentation.docs
folder of thepinax/pinax
repository and create a new file (right click "New File") namedquick_start_manual.md
.quick_start.md
file, copy the content, and paste it into your newquick_start_manual.md
file. At the very top of the file you should change the title "Quick Start" to "Quick Start Manual", then save the file.quick_start.md
file and update the file the same way you updated theREADME.md
file earlier to showcase the newpinax-cli
way of starting projects.pinax-cli
way so you should add one sentence to the document letting people know that if they are interested in learning about the manual way of installing a Pinax project, they should visit the "Quick Start Manual" page of the documentation. It would be good if you would link to this page from thequick_start.md
page. Don't forget to save your changes.mkdocs.yml
and add the following line- ["quick_start_manual.md", "Introduction", "Quick Start Manual"]
right underneath this line- ["quick_start.md", "Introduction", "Quick Start"]
. Save your changes.index.md
file and add the following line* [Quick Start Manaual](quick_start_manual.md)
right underneath the following line* [Quick Start](quick_start.md)
. Don't forget to save your changes.mkdocs serve
into your terminal. Make sure youcd'd
into the folder in which you copied your forked repository first. Then type127.0.0.1:8000/
into your browser and you should see the Pinax documentation including the changes you made. Awesome!One of us will then review your pull request and if everything looks great we will merge it (you will receive an email notification from GitHub). If you need to make additional changes, we will comment on your pull request and help you figure out the next steps. Don't worry, this is totally normal and doesn't mean that your pull request isn't awesome. Sometimes it just happens that a few things need to be tweaked.
If you have any questions or need help, comment on this issue and mention me @ossanna16 (I will receive a notification this way). One of us will then reply and help you. It's even better if you would join our Pinax Slack channel (it's free). Someone is always there to help and answer any questions. If you'd like to reach me personally mention me @anna in our Pinax project Slack channel. Please remember that there are no stupid questions. We want to help you succeed and want to help you make your first open source contribution. 😊
The text was updated successfully, but these errors were encountered: