Simplified the contribution article for Symfony Docs #6367
Conversation
| One of the essential principles of the Symfony project is that **documentation | ||
| is as important as code**. That's why a great amount of resources are dedicated | ||
| to documenting new features and to keeping the rest of the documentation up-to- | ||
| date. |
There was a problem hiding this comment.
"up-to-date" must be on one line. Otherwise, the newline is treated as a space.
|
|
||
| $ git remote -v | ||
| origin https://github.com/<YOUR GITHUB USERNAME>/symfony-docs.git (fetch) | ||
| origin https://github.com/<YOUR GITHUB USERNAME>/symfony-docs.git (push) |
There was a problem hiding this comment.
For your own repository, their shouldn't be HTTPS URLs (we cloned using Git over SSH before).
|
@xabbuh I've made all the changes you asked for. Thanks for the review. This is now ready for the final review. |
| automatically and you can then create the Pull Request. | ||
|
|
||
| If your contribution is large or if you prefer to work on your own computer, | ||
| keep reading this guide to learn an alternative way to send pull requests to |
|
👍 |
|
I've fixed the last errors and suggestions. Thanks! |
| * Symfony documentation is published under a | ||
| :doc:`Creative Commons BY-SA 3.0 License </contributing/documentation/license>` | ||
| and all your contributions will implicitly adhere to that license. | ||
|
|
||
| .. _minor-changes-e-g-typos |
| First, switch to the oldest maintained Symfony branch which contains the error, | ||
| which is usually ``2.3``. Then, click on the **edit this page** button on the | ||
| upper right corner. Now edit the content and describe your changes within the | ||
| GitHub frontend. |
There was a problem hiding this comment.
I think we should remove this. If it's a small change, this is a big step to figure out, and in about 1 month. 2.3 won't be the oldest version anymore :). Also, it shouldn't be a problem in most cases to merge to the correct branch.
There was a problem hiding this comment.
To be clear, I mean remove the first sentence only (then re-word the second)
A picture here would be sweet too.
| you are probably comfortable with all the Git-magic involved in the process. | ||
| That's why your next contributions would be much faster. Here you can find the | ||
| complete steps to contribute to the Symfony documentation, which you can use as | ||
| a **checklist**: |
There was a problem hiding this comment.
Check you out! You've made your first contribution to the Symfony documentation!
Somebody throw a party! Your first contribution took a little extra time because you
needed to learn a few standards and setup your computer. But now, you're dangerous.Here is a complete checklist of steps that will guide you through your next contribution
to the Symfony docs:
|
Sorry - late to the party. I suggested some changes - do with them what you want @javiereguiluz - some of them are just Ryan-isms 💃 👍 |
|
@weaverryan thanks for your great review. I've fixed everything and as a bonus I've added some screenshots too. |
|
Thank you Javier. |
…iereguiluz) This PR was squashed before being merged into the 2.3 branch (closes #6367). Discussion ---------- Simplified the contribution article for Symfony Docs After last Saturday's Hack Day, I realized that we could simplify the documentation of the contribution process significantly. I'll propose changes to the code contribution, but let's start with the doc contribution. Commits ------- eeb6abb Simplified the contribution article for Symfony Docs
|
Yes, awesome! |
After last Saturday's Hack Day, I realized that we could simplify the documentation of the contribution process significantly. I'll propose changes to the code contribution, but let's start with the doc contribution.