Skip to content

Remove Debugging Guide #8538

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 10, 2017
Merged

Remove Debugging Guide #8538

merged 1 commit into from
Nov 10, 2017

Conversation

weaverryan
Copy link
Member

In 3.4, the debugging article has details about bootstrap.php.cache, etc. But in 4 (as you can see), it has almost nothing! I think we should remove it (and remove the Guide link on Symfony.com for version 4). The individual debug: commands should be documented in those sections - nobody will click "Debug" so they can learn about how to debug something specific (e.g. translations).

Cheers!

javiereguiluz
javiereguiluz approved these changes Oct 24, 2017
View reviewed changes
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this proposal. I'd be more happy if the debugging commands were already moved to their new locations instead of "losing" them ... but we can do that in a separate PR.

@weaverryan
Copy link
Member Author

@javiereguiluz when we merge this, will the guide link automatically disappear on symfony.com (for 4.0 only)? Or does more work need to be done for that?

@weaverryan weaverryan mentioned this pull request Oct 24, 2017
Closed
@wouterj
Copy link
Member

wouterj commented Oct 25, 2017

#7071 😢

@weaverryan
Copy link
Member Author

@wouterj Oh no!!! I completely ran over your work :/. I'm sorry. My vote is still to merge this PR... because (as nice as your article is), it doesn't contain a lot of content (I like the details on dump(), but we should show that elsewhere, and I also have seen that almost everyone knows about this function... somehow).

@javiereguiluz javiereguiluz mentioned this pull request Oct 29, 2017
Closed
12 tasks
@weaverryan
Copy link
Member Author

@javiereguiluz if you still agree with this proposal, could you remove the Debugging entry from symfony.com? Thanks for removing the other sections on my other PR :)

@weaverryan
Copy link
Member Author

ping @javiereguiluz!

This is not super important, but I'd love to finish it :)

@javiereguiluz
Copy link
Member

I've removed the link to "Debug" ... it will be online after the next deploy. Thanks!

@weaverryan weaverryan merged commit acdc22a into symfony:master Nov 10, 2017
weaverryan added a commit that referenced this pull request Nov 10, 2017
@weaverryan
minor #8538 Remove Debugging Guide (weaverryan)
724e5c4 
This PR was merged into the master branch.

Discussion
----------

Remove Debugging Guide

In 3.4, the debugging article has details about `bootstrap.php.cache`, etc. But in 4 (as you can see), it has almost nothing! I think we should remove it (and remove the Guide link on Symfony.com for version 4). The individual `debug:` commands should be documented in those sections - nobody will click "Debug" so they can learn about how to debug something specific (e.g. translations).

Cheers!

Commits
-------

acdc22a no more debugging
@weaverryan weaverryan mentioned this pull request Nov 10, 2017
Closed
8 tasks
@javiereguiluz javiereguiluz mentioned this pull request Feb 9, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@javiereguiluz javiereguiluz javiereguiluz approved these changes

Assignees
No one assigned
Labels
Status: Reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@weaverryan @wouterj @javiereguiluz @carsonbot