Fix all broken links/permanent redirects/removed anchors #5553
Conversation
| @@ -429,9 +429,7 @@ A great way to see the core functionality in action is to look in the | |||
| Redirecting | |||
| ~~~~~~~~~~~ | |||
|
|
|||
| If you want to redirect the user to another page, use the | |||
| :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::redirect` | |||
There was a problem hiding this comment.
Controller API method links are removed as these methods are protected. Only public methods are included in the online API doc.
There was a problem hiding this comment.
this should be changed IMO. Protected methods are extension point, so they should be documented in the API doc too (private methods should indeed not appear)
|
Is it possible to make this link checker run on Travis ? |
| and calls the controller. The ``forward()`` method returns the ``Response`` | ||
| object that's returned from *that* controller:: | ||
| with the ``forward()`` method. Instead of redirecting the user's browser, it | ||
| makes an internal sub-request, and calls the controller. The ``forward()`` |
There was a problem hiding this comment.
Should we remove the comma before the and?
There was a problem hiding this comment.
yes, but let's do that in the docbot PRs and keep this one focussed on URLs.
|
👍 thanks a lot for fixing all these errors! |
|
@stof it is possible (it's quite easy, as it's a built-in sphinx builder). However, I don't think it's worth it, as there are many URLs in the Symfony documentation (so running this builder takes some minutes) and not a lot of PRs add new external references. I want to provide a PR status to the contributor as quick as possible, so I don't think making the travis build longer is really needed here. I thought about only including it in push Travis builds (and not PRs updates). However, we don't get emails about failing builds (and least, I don't get them) and I don't think we'll regularly check Travis to see the status of the branch. |
|
@wouterj for push builds, the one receiving the email is the dev doing the push, which means the one doing the merge of the PR. |
|
Reverted the removal of all API method links to protected methods, I agree that it should be fixed in the API generator instead. Ready to merge imo (fyi, @stof, we decided against adding this to the build during the doc meeting). |
| @@ -89,4 +89,4 @@ repository and apply changes to the translated documents as soon as possible. | |||
| repositories as obsolete documentation is dangerous. | |||
|
|
|||
| .. _`an ongoing discussion`: https://github.com/symfony/symfony-docs/issues/4078 | |||
| .. _Symfony docs mailing-list: http://groups.google.com/group/symfony-docs | |||
| .. _Symfony docs mailing-list: https://groups.google.com/forum/#!forum/symfony-docs | |||
There was a problem hiding this comment.
This one should probably be removed as it has been disabled for quite some time now.
|
I've removed the mailing list link in 185dfbf, as noticed by @fabpot. /cc @weaverryan @xabbuh can you please review & vote? |
|
I just scanned through - looks like all good stuff to me! 👍 |
…(WouterJ) This PR was merged into the 2.3 branch. Discussion ---------- Fix all broken links/permanent redirects/removed anchors Today, I discovered that Sphinx has a built-in link checker. I couldn't resist running it and fixing everything it found. It turns out that we had a lot of broken/permanently redirected links. | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | - Commits ------- 185dfbf Remove sf-doc mailing list link 80a560f Inline links to Symfony docs a858888 Fix all invalid API doc links 123d05f Fix all broken links 3c830bc Fix all permanent redirects 09b3b1b Create your own Framework tutorial is moved to the docs
Today, I discovered that Sphinx has a built-in link checker. I couldn't resist running it and fixing everything it found.
It turns out that we had a lot of broken/permanently redirected links.