Added a link to open new issue with prefilled details #3683

bansalnitish · 2018-02-26T18:14:30Z

This PR fixes #3539. It includes a link to open a new issue.

stsewd · 2018-02-26T18:22:31Z

readthedocs/templates/builds/build_detail.html

@@ -161,6 +162,11 @@ <h3>{% trans "Error" %}</h3>
           data-bind="text: error">
          {{ build.error }}
        </p>
+        <p>
+        {% blocktrans with build_id=build.pk proj_name=build.project.name build_path=request.get_full_path user_name=request.user %}
+         Report any build issues <a href="https://github.com/rtfd/readthedocs.org/issues/new?title=Build%20error%20with%20build%20id%20%23{{ build_id }}&body=%23%23%20Details%0A%0A*%20Project%20Url%3A%20https://readthedocs.org/projects/{{ proj_name }}/%0A*%20Build%20URL%20(if%20applicable)%3A%20https://readthedocs.org{{ build_path }}%0A*%20Read%20the%20Docs%20username%20(if%20applicable)%3A%20{{ user_name }}%0A%0A%23%23%20Expected%20Result%0A%0A*%20A%20description%20of%20what%20you%20wanted%20to%20happen*%0A%0A%23%23%20Actual%20Result%0A%0A*A%20description%20of%20what%20actually%20happened*%0A">here</a>.


Can you split this line for better readability (with each param per line o something like that)?

@stsewd I have made the changes!

stsewd · 2018-02-26T18:47:22Z

readthedocs/templates/builds/build_detail.html

+         title=Build%20error%20with%20build%20id%20%23{{ build_id }}
+         &body=%23%23%20Details%0A%0A
+         *%20Project%20Url%3A%20https://readthedocs.org/projects/{{ proj_name }}/%0A
+         *%20Build%20URL%20(if%20applicable)%3A%20https://readthedocs.org{{ build_path }}%0A


build_path already includes the /, right?

Project Url, URL uppercase (same as the template)

Also there is some way of django to do the encoding here? Something like https://github.com/rtfd/readthedocs.org/pull/3457/files#diff-02c668683a9a481865c186f12f7452e0R74

Yup build_path includes /.

bansalnitish · 2018-02-26T22:10:02Z

@stsewd I have encoded the URL.

stsewd · 2018-02-26T22:30:48Z

I was thinking something inside the template, but let's wait to see what others think.

bansalnitish · 2018-02-26T22:39:18Z

@stsewd I will try finding a way to encode it inside the template!

agjohnson

Thanks for the contribution! I think this will need some refactoring and clean up before it can be merged, but I think the approach is mostly correct.

agjohnson · 2018-02-28T00:23:46Z

readthedocs/builds/views.py

+        actual_res = "## Actual Result\n\n*A description of what actually happened*"
+        body = body + quote(proj + build + uname + expec_res + actual_res)
+        issue_url = issue + title + body
+        context['issue_url'] = issue_url


This is tough to follow due to excessive variable usage. Perhaps this could be simplified into a single multi line string with interpolation through .format() and a dictionary as input. This should feed into urlparse to actually create a URL

agjohnson · 2018-02-28T00:24:42Z

readthedocs/builds/views.py

@@ -82,6 +83,17 @@ class BuildDetail(BuildBase, DetailView):
    def get_context_data(self, **kwargs):
        context = super(BuildDetail, self).get_context_data(**kwargs)
        context['project'] = self.project
+        issue = "https://github.com/rtfd/readthedocs.org/issues/new?title="


urlparse is a better way to build a URL. There are a number of problems with building by hand through string concatenation.

agjohnson · 2018-02-28T00:25:56Z

readthedocs/templates/builds/build_detail.html

@@ -161,6 +162,11 @@ <h3>{% trans "Error" %}</h3>
           data-bind="text: error">
          {{ build.error }}
        </p>
+        <p>
+        {% blocktrans with url=issue_url %}
+         Report any build issues <a href="{{ url }}">here</a>.


This should be surrounded in a template block so that we can avoid this block on our commercial hosting site. We don't want github issues from build errors there.

@agjohnson I didn't get this one. Can you just make this a bit more clear? Your reason is perfectly fine, I agree with that too. But I didn't get how to do this one. Sorry I may be not familiar with this.

Sorry, I should have clarified more here. You'll want to use a named block, something like:

{% block github_issue_link %} {% blocktrans %} ... {% endblocktrans %} {% endblock %}

That way, we can override this on our commercial hosting and avoid a link to GitHub.

Okay Thanks !

bansalnitish · 2018-02-28T21:17:07Z

@agjohnson I have made the requested changes. Can you have a look once ?

bansalnitish · 2018-03-04T17:10:44Z

@agjohnson Any updates on this ?

stsewd · 2018-03-04T17:18:43Z

readthedocs/builds/views.py

+                  "?title={title}{build_id}"
+                  "&body={body}")
+
+        body = ("# Details:\n\n"


Is better if you use the multistring syntax here ("""), so it's more clear and you will not need to add \n.

Removing the \n creates trouble when quote is used to render url. Newlines and spaces are not converted properly. So, I used the \n.

If you're having trouble with spaces, consider https://docs.python.org/2/library/textwrap.html#textwrap.dedent

Thanks for this @agjohnson, I have updated the string syntax!

stsewd · 2018-03-04T17:19:58Z

readthedocs/builds/views.py

+                     'uname': self.request.user}
+
+        scheme_dict = {'title': quote("Build error with build id #"),
+                       'build_id': self.request.path[-2:-1],


There is a better way to get the build_id? The id isn't always 2 characters length.

Fixed this!

stsewd · 2018-03-04T17:23:23Z

readthedocs/builds/views.py

+                "## Actual Result\n\n"
+                "*A description of what actually happened*")
+
+        body_dict = {'projname': self.project,


I thinks is more clear if you use this on the format method directly, since isn't used on other parts of the code.

agjohnson · 2018-03-16T02:18:05Z

Marking partially blocked on #3399

humitos · 2019-01-09T16:29:22Z

Marking partially blocked on #3399

I don't want to block this PR on this issue. I think it's related, but we are not putting effort on that just yet.

We should merge this PR in the meanwhile and enjoy this benefit by helping users to provide all the information needed for proper debugging.

This is how it looks like when a generic error happens.

humitos · 2019-01-09T16:30:03Z

and this is the link generated for that case:

https://github.com/rtfd/readthedocs.org/issues/new?title=Build%20error%20with%20build%20id%20%231892&body=%0A%23%23%20Details%3A%0A%0A%2A%20Project%20URL%3A%20https%3A//readthedocs.org/projects/test-builds/%0A%2A%20Build%20URL%28if%20applicable%29%3A%20https%3A//readthedocs.org/projects/test-builds/builds/1892/%0A%2A%20Read%20the%20Docs%20username%28if%20applicable%29%3A%20humitos%0A%0A%23%23%20Expected%20Result%0A%0A%2AA%20description%20of%20what%20you%20wanted%20to%20happen%2A%0A%0A%23%23%20Actual%20Result%0A%0A%2AA%20description%20of%20what%20actually%20happened%2A

humitos

This PR is ready to merge once tests pass.

stsewd · 2019-01-21T16:32:23Z

This is blocked by #4543 (it uses urlparse)

humitos · 2019-01-21T16:39:49Z

I don't want to block PRs on dropping Py2 support. Once merged, #4543 will automatically upgrade the code that's needed to upgrade using the script.

ericholscher · 2019-01-22T14:17:52Z

Merging master to get tests passing, then we should merge. 👍

stsewd reviewed Feb 26, 2018

View reviewed changes

bansalnitish force-pushed the preFilledIssue branch from b2bd677 to 100e2df Compare February 26, 2018 18:27

stsewd reviewed Feb 26, 2018

View reviewed changes

bansalnitish force-pushed the preFilledIssue branch from da61c8e to db0a618 Compare February 26, 2018 22:23

bansalnitish force-pushed the preFilledIssue branch from db0a618 to fcaf2d5 Compare February 26, 2018 22:36

agjohnson requested changes Feb 28, 2018

View reviewed changes

bansalnitish force-pushed the preFilledIssue branch 13 times, most recently from 741eb44 to 1d09ed1 Compare February 28, 2018 21:09

bansalnitish force-pushed the preFilledIssue branch 2 times, most recently from c99b41d to 2096dc9 Compare February 28, 2018 21:29

RichardLitt added the PR: ready for review label Mar 2, 2018

stsewd reviewed Mar 4, 2018

View reviewed changes

agjohnson added PR: work in progress Pull request is not ready for full review Status: blocked Issue is blocked on another issue and removed PR: ready for review labels Mar 16, 2018

stsewd mentioned this pull request Apr 9, 2018

Mention RTD in the Project URL of the issue template #3928

Merged

humitos force-pushed the preFilledIssue branch from 9d51b39 to e37a25f Compare January 9, 2019 16:28

humitos removed PR: work in progress Pull request is not ready for full review Status: blocked Issue is blocked on another issue labels Jan 9, 2019

humitos requested a review from a team January 9, 2019 16:30

bansalnitish and others added 8 commits January 19, 2019 21:50

Added a link to open new issue with prefilled details

5f3ca53

Requested Changes

6ad59e6

fix spacing

7ccd8b6

Make markdown bullets render properly

4b3fde7

Style fixing

59b533f

Make the whole text the actionable link

60672aa

Maybe we could load the .md template that we already have

02979dc

Suggest to open an issue only if the error is generic

d075d54

readthedocs deleted a comment from todo bot Jan 19, 2019

Always include the project object in the context

2f337dd

humitos force-pushed the preFilledIssue branch from d8ab392 to 2f337dd Compare January 19, 2019 21:02

humitos approved these changes Jan 19, 2019

View reviewed changes

humitos mentioned this pull request Jan 21, 2019

Upgrade all code to be Python3 only #5065

Merged

12 tasks

Merge remote-tracking branch 'origin/master' into preFilledIssue

3ebcf90

ericholscher merged commit 3b7ff83 into readthedocs:master Jan 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added a link to open new issue with prefilled details #3683

Added a link to open new issue with prefilled details #3683

bansalnitish commented Feb 26, 2018

stsewd Feb 26, 2018

bansalnitish Feb 26, 2018 •

edited

Loading

stsewd Feb 26, 2018

bansalnitish Feb 26, 2018

bansalnitish commented Feb 26, 2018

stsewd commented Feb 26, 2018

bansalnitish commented Feb 26, 2018

agjohnson left a comment

agjohnson Feb 28, 2018

agjohnson Feb 28, 2018

agjohnson Feb 28, 2018

bansalnitish Feb 28, 2018 •

edited

Loading

agjohnson Feb 28, 2018

bansalnitish Feb 28, 2018

bansalnitish commented Feb 28, 2018

bansalnitish commented Mar 4, 2018

stsewd Mar 4, 2018

bansalnitish Mar 4, 2018

agjohnson Mar 16, 2018

bansalnitish Apr 13, 2018

stsewd Mar 4, 2018

bansalnitish Mar 4, 2018

stsewd Mar 4, 2018

bansalnitish Mar 4, 2018

agjohnson commented Mar 16, 2018

humitos commented Jan 9, 2019

humitos commented Jan 9, 2019

humitos left a comment

stsewd commented Jan 21, 2019 •

edited

Loading

humitos commented Jan 21, 2019

ericholscher commented Jan 22, 2019

Added a link to open new issue with prefilled details #3683

Added a link to open new issue with prefilled details #3683

Conversation

bansalnitish commented Feb 26, 2018

Choose a reason for hiding this comment

bansalnitish Feb 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bansalnitish commented Feb 26, 2018

stsewd commented Feb 26, 2018

bansalnitish commented Feb 26, 2018

agjohnson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bansalnitish Feb 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bansalnitish commented Feb 28, 2018

bansalnitish commented Mar 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agjohnson commented Mar 16, 2018

humitos commented Jan 9, 2019

humitos commented Jan 9, 2019

humitos left a comment

Choose a reason for hiding this comment

stsewd commented Jan 21, 2019 • edited Loading

humitos commented Jan 21, 2019

ericholscher commented Jan 22, 2019

bansalnitish Feb 26, 2018 •

edited

Loading

bansalnitish Feb 28, 2018 •

edited

Loading

stsewd commented Jan 21, 2019 •

edited

Loading