Revamped the documentation about "Contributing Docs" #4223
Conversation
|
the description of the PR seems incomplete |
|
@stof it's fixed now :) |
| .. code-block:: text | ||
|
|
||
| https://github.com/symfony/symfony-docs | ||
| * Symfony documentation is written using `reStructuredText`_ markup language. |
There was a problem hiding this comment.
There's no target given for "reStructuredText" at the end of the file. Should probably be the same as in format.rst.
There was a problem hiding this comment.
Never mind, it seems that you fixed it in the meantime. :)
| | Fixed tickets | #1075 | ||
| | New docs? | no | ||
| | Applies to | 2.3+ | ||
| | Fixed tickets | #10575 |
There was a problem hiding this comment.
why changing this number ? The highest number in the doc repo is still far from 10000
There was a problem hiding this comment.
I wanted to use a real looking but non-existent number.
There was a problem hiding this comment.
Why shouldn't it exists? I find the previous better
|
btw, the rule about relative links should be added in the doc standards. It is not written currently |
|
The rule about internal relative links has been added here: 991ff6f |
| directive to show the configuration in all supported configuration formats | ||
| (``PHP``, ``YAML``, and ``XML``) | ||
| (``PHP``, ``YAML``, and ``XML``). Example: |
There was a problem hiding this comment.
you should remove the serial comma and maybe link to the standards here to show the full list of languages?
|
|
||
| $ git clone git://github.com/YOURUSERNAME/symfony-docs.git | ||
| Let's imagine that you want to improve the installation chapter of the Symfony | ||
| book. In order to do those changes, follow these steps: |
There was a problem hiding this comment.
In order to make your changes,
|
Ryan, thanks for your great review. I'm really sorry for having made so many mistakes :( |
|
Pff, you only make as many mistakes as I do :) - it's much easier to do "cleanup" on someone else's work. Thanks very much for this! |
…aviereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- Revamped the documentation about "Contributing Docs" | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | 2.3+ | Fixed tickets | - This is the first step into completely revamping the *Contributing* section documentation. The main changes are: * A much more friendly and welcoming tone. * Thorough and step-by-step explanations that assumes no previous knowledge from the reader. * The use of real examples to illustrate the explanations, instead of using abstract concepts. * The old [Managing Releases](http://symfony.com/doc/current/contributing/documentation/overview.html#managing-releases) section has been completely removed. This has nothing to do with contributing documentations. It's just documentation for a process that only concerns to doc maintainers. Commits ------- 88ddbb1 Fixed all the errors found by Ryan baa06b5 Removed two highlight formats which are "experimental" and not used by end users 9bcd33d More and more fixes and improvements 15f3c94 Added another bunch of fixes suggested by reviewers ff66e94 Added lots of fixes suggested by reviewers 991ff6f Added a note about not using relative internal links in the doc 79375ae Switched another relative link into an absolute reference 4751eb9 lways use absolute links instead of relative for internal doc links 53c3a16 Added missing link 723603c Revamped the documentation about "Contributing Docs"
This PR was merged into the 2.3 branch. Discussion ---------- [Contributing] tweaks to the contribution chapter | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | Some tweaks for the changes made in #4223. @javiereguiluz Sorry, didn't find the time to review it in the first run. Commits ------- f4b0b8e tweaks to the contribution chapter
This is the first step into completely revamping the Contributing section documentation. The main changes are: