Explain how to provide a stack trace #7875

greg0ire · 2017-05-05T15:21:47Z

I miss a reference explaining how to do that properly and keep asking people to do it, so maybe here is the right place?

greg0ire · 2017-05-05T15:25:35Z

As a bonus, I added a link to the Slack channel.

PeterFour · 2017-05-05T15:28:21Z

contributing/code/bugs.rst

-* Ask for assistance on `Stack Overflow`_ or on the #symfony `IRC channel`_
-  if you're not sure if your issue is really a bug.
+* Ask for assistance on `Stack Overflow`_ on the #symfony `IRC channel`_, or on
+  the #support channel of `the Symfony Slack` if you're not sure if your issue


I think he markup is broken for the Slack link

You're right, let's fix it.

Simperfit · 2017-05-05T15:28:02Z

contributing/code/bugs.rst

-* Ask for assistance on `Stack Overflow`_ or on the #symfony `IRC channel`_
-  if you're not sure if your issue is really a bug.
+* Ask for assistance on `Stack Overflow`_ on the #symfony `IRC channel`_, or on
+  the #support channel of `the Symfony Slack` if you're not sure if your issue


Maybe we could add the link of the symfony slack

Simperfit · 2017-05-05T15:29:11Z

contributing/code/bugs.rst

+  version, which should appear at the bottom of the page. *Do not* provide it
+  as a screenshot, since search engines will not be able to index the text
+  inside them. If the stack trace is long, consider enclosing it in a
+  ``<details>`` html tag.


Maybe we should warn people about security on what they put in the <details>

I think this even stand for SO or irc.

Yeah but the <details> part does not, and SO has its own reference.

Maybe IRC and Slack need their own reference?

Correct, I meant that in the general sense, pasting stack trace somewhere need to be done carefully

javiereguiluz · 2017-05-08T09:37:19Z

contributing/code/bugs.rst

@@ -32,9 +33,19 @@ If your problem definitely looks like a bug, report it using the official bug
 * Give as much detail as possible about your environment (OS, PHP version,
  Symfony version, enabled extensions, ...);

+* If you want to provide a stack trace you got on an html page, be sure to


I think I'd recommend the opposite: always share the stack traces as images because they offer some protection against Google, etc. Remember that traces can contain sensitive information, so we don't make them searchable on Internet.

IMO sensitive data is the exception, not the rule, and a big drawback of using them that I did not mention is that you can't copy paste from them, making the work harder for people who want to check files mentioned in it. Also, these images can be resized if too big, which can make the text illegible. Also if not cropped properly, they might contain even more sensitive data, like what the desktop of the reporter looks like. Finally, even with a screenshot, you should redact sensitive information, so...

If you expose sensitive information you are already F**ked, posting this in a screenshot will not prevent anyone from abusing this information. Not to mention that search engines can perform OCR.

I'm also for plain text, because it allows search engines to match exception messages that people encounter, so they may be redirected to the correct issue just by googling the exception itself

sstok · 2017-05-09T09:10:04Z

contributing/code/bugs.rst

+  able to index the text inside them. Same goes for errors encountered in a
+  terminal, do not take a screenshot, but learn how to copy/paste from it. If
+  the stack trace is long, consider enclosing it in a ``<details>`` html tag.
+  Be wary that stack traces may contain sensible information, and if it is the


This should be made bold to make it more important (end less change to miss it).

Pierstoval · 2017-05-09T09:36:54Z

contributing/code/bugs.rst

+  page. *Do not* provide it as a screenshot, since search engines will not be
+  able to index the text inside them. Same goes for errors encountered in a
+  terminal, do not take a screenshot, but learn how to copy/paste from it. If
+  the stack trace is long, consider enclosing it in a ``<details>`` html tag.


Maybe a link to a documentation example?

I'll try, let's hope the backticks I used do not confuse rst

Pierstoval · 2017-05-09T09:37:23Z

contributing/code/bugs.rst

+  terminal, do not take a screenshot, but learn how to copy/paste from it. If
+  the stack trace is long, consider enclosing it in a ``<details>`` html tag.
+  **Be wary that stack traces may contain sensitive information, and if it is
+  the case, be sure to redact them prior to posting your stack trace.**


s/redact/remove/

What's wrong with "redact"? IMO it's very appropriate in this context (I'm saying that because I've seen a lot of "redacted" out there, didn't you?).

cc @alexislefebvre

greg0ire · 2017-05-09T11:17:00Z

contributing/code/bugs.rst

+  page. *Do not* provide it as a screenshot, since search engines will not be
+  able to index the text inside them. Same goes for errors encountered in a
+  terminal, do not take a screenshot, but learn how to copy/paste from it. If
+  the stack trace is long, consider enclosing it in a ` ``<details>`` html tag`_.


This link doesn't work, if anyone know how to fix it I'm all ears

alexislefebvre · 2017-05-10T08:41:45Z

contributing/code/bugs.rst

+  terminal, do not take a screenshot, but learn how to copy/paste from it. If
+  the stack trace is long, consider enclosing it in a `<details> html tag`_.
+  **Be wary that stack traces may contain sensitive information, and if it is
+  the case, be sure to redact them prior to posting your stack trace.**


Did you mean remove instead of redact?

No, I did not but you are the second person to ask me that, so let me check the meaning.

@alexislefebvre @Pierstoval it really seems appropriate : http://www.linguee.fr/francais-anglais/search?source=anglais&query=redact WDYT?

I see both of you are french so maybe you're just unaware that redact is a faux-ami ?

You're right, I didn't know the meaning of redact. 😅 Maybe you should simply write edit?

I did know the meaning of "redact" so it didn't shocked me 🤣

Even though, if some people are confused, maybe the word should be changed without breaking the global understanding of the paragraph. Not every Symfony user is english-native 🙂

@alexislefebvre edit does not convey the full meaning, and I don't think we should dumb it down with remove. I think people can easily infer the meaning of the word if they don't know it already, and that means they will have learned something, so IMO it's better to stick with that.

xabbuh

I really like this a lot. 👍

greg0ire · 2017-05-12T10:07:28Z

Thanks @xabbuh 😊

xabbuh · 2017-05-17T07:05:01Z

Thank you @greg0ire.

…iluz) This PR was merged into the 2.7 branch. Discussion ---------- Explain how to provide a stack trace I miss a reference explaining how to do that properly and keep asking people to do it, so maybe here is the right place? Commits ------- 1648c6f Minor fix 6d3ecc9 Minor changes 2972d23 Explain how to provide a stack trace 83f5e1d Add link to the Slack support channel

* 2.7: (21 commits) Update optional_dependencies.rst Fix xml blocks [#7875] minor tweaks Minor fix Minor changes [#7773] fix line length Add helpful remarks on custom DataCollector Remove use of deprecated security.exception_listener.class parameter Update resources.rst Fix incoherent ut8mb4 collation in Doctrine setup Fix decorating service definition fix empty XML element [#7873] add missing toctree entries Reworded the introduction of the contributing docs [HttpFoundation] Fix clearstatcache first arg Explain how to provide a stack trace Add link to the Slack support channel Mentioned FOSRestBundle's content negotiation Used the article example consistently in the example Update formats.rst ...

* 2.8: (24 commits) Update optional_dependencies.rst Fix xml blocks pass only strings to loadUserByUsername() Fix Authenticator Class (getCredentials) example Added the picture that shows how GuardAuthenticationListener calls Authentication Guard methods. [#7875] minor tweaks Minor fix Minor changes [#7773] fix line length Add helpful remarks on custom DataCollector Remove use of deprecated security.exception_listener.class parameter Update resources.rst Fix incoherent ut8mb4 collation in Doctrine setup Fix decorating service definition fix empty XML element [#7873] add missing toctree entries Reworded the introduction of the contributing docs [HttpFoundation] Fix clearstatcache first arg Explain how to provide a stack trace Add link to the Slack support channel ...

* origin/2.7: (51 commits) Avoid backticks in shell scripts Update optional_dependencies.rst Fix xml blocks [#7875] minor tweaks Minor fix Minor changes [#7773] fix line length Add helpful remarks on custom DataCollector Remove use of deprecated security.exception_listener.class parameter Update resources.rst Fix incoherent ut8mb4 collation in Doctrine setup Fix decorating service definition fix empty XML element [#7873] add missing toctree entries Reworded the introduction of the contributing docs [#7844] add XML and PHP config examples Property access [HttpFoundation] Fix clearstatcache first arg Explain how to provide a stack trace fix remaining setDefinition() call ...

* 3.2: (39 commits) updating instance Avoid backticks in shell scripts Update optional_dependencies.rst Fix xml blocks pass only strings to loadUserByUsername() Fix Authenticator Class (getCredentials) example Documented addAnnotatedClassesToCompile() and the use of class patterns Added the picture that shows how GuardAuthenticationListener calls Authentication Guard methods. [#7205] minor tweak Simplified the use of transChoice() [#7875] minor tweaks Minor fix Minor changes Properly show all events and describe guard events [#7891] remove not needed sentence [#7773] fix line length Add helpful remarks on custom DataCollector Remove use of deprecated security.exception_listener.class parameter Update resources.rst Fix incoherent ut8mb4 collation in Doctrine setup ...

* 3.4: (40 commits) Adding an article to explain the 3.3 changes, and how to upgrade updating instance Avoid backticks in shell scripts Update optional_dependencies.rst Fix xml blocks pass only strings to loadUserByUsername() Fix Authenticator Class (getCredentials) example Documented addAnnotatedClassesToCompile() and the use of class patterns Added the picture that shows how GuardAuthenticationListener calls Authentication Guard methods. [#7205] minor tweak Simplified the use of transChoice() [#7875] minor tweaks Minor fix Minor changes Properly show all events and describe guard events [#7891] remove not needed sentence [#7773] fix line length Add helpful remarks on custom DataCollector Remove use of deprecated security.exception_listener.class parameter Update resources.rst ...

carsonbot added the Status: Needs Review label May 5, 2017

Simperfit approved these changes May 5, 2017

View reviewed changes

PeterFour reviewed May 5, 2017

View reviewed changes

greg0ire force-pushed the stack_trace branch from c215a64 to 06d1e67 Compare May 5, 2017 15:29

Simperfit reviewed May 5, 2017

View reviewed changes

Add link to the Slack support channel

83f5e1d

greg0ire force-pushed the stack_trace branch 2 times, most recently from d61f587 to 1b8ed9f Compare May 5, 2017 15:32

Simperfit approved these changes May 5, 2017

View reviewed changes

greg0ire force-pushed the stack_trace branch from 1b8ed9f to 296b160 Compare May 5, 2017 15:50

javiereguiluz reviewed May 8, 2017

View reviewed changes

sstok reviewed May 9, 2017

View reviewed changes

greg0ire force-pushed the stack_trace branch 2 times, most recently from ca00866 to f4cdad6 Compare May 9, 2017 09:13

Pierstoval reviewed May 9, 2017

View reviewed changes

greg0ire force-pushed the stack_trace branch 2 times, most recently from 451eb28 to f454943 Compare May 9, 2017 10:25

greg0ire commented May 9, 2017

View reviewed changes

greg0ire force-pushed the stack_trace branch from f454943 to 944e003 Compare May 9, 2017 11:21

Explain how to provide a stack trace

2972d23

greg0ire force-pushed the stack_trace branch from 944e003 to 2972d23 Compare May 9, 2017 11:34

alexislefebvre reviewed May 10, 2017

View reviewed changes

xabbuh approved these changes May 12, 2017

View reviewed changes

xabbuh added Status: Reviewed and removed Status: Needs Review labels May 12, 2017

xabbuh added this to the 2.7 milestone May 15, 2017

Pierstoval approved these changes May 15, 2017

View reviewed changes

javiereguiluz added 2 commits May 17, 2017 09:01

Minor changes

6d3ecc9

Minor fix

1648c6f

javiereguiluz approved these changes May 17, 2017

View reviewed changes

xabbuh merged commit 1648c6f into symfony:2.7 May 17, 2017

xabbuh added a commit that referenced this pull request May 17, 2017

[#7875] minor tweaks

18238aa

greg0ire deleted the stack_trace branch May 17, 2017 10:32

Uh oh!

Explain how to provide a stack trace #7875

Explain how to provide a stack trace #7875

Uh oh!

Conversation

greg0ire commented May 5, 2017

Uh oh!

greg0ire commented May 5, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Simperfit May 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PeterFour May 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greg0ire May 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greg0ire May 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xabbuh left a comment

Choose a reason for hiding this comment

Uh oh!

greg0ire commented May 12, 2017

Uh oh!

xabbuh commented May 17, 2017

Uh oh!

Uh oh!

Simperfit May 5, 2017 •

edited

Loading

PeterFour May 5, 2017 •

edited

Loading

greg0ire May 8, 2017 •

edited

Loading

greg0ire May 9, 2017 •

edited

Loading