Skip to content
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.

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

UI: Improve error message about PullRequests #9177

Closed
2 tasks done
buhtz opened this issue Apr 28, 2023 · 12 comments · Fixed by #9237
Closed
2 tasks done

UI: Improve error message about PullRequests #9177

buhtz opened this issue Apr 28, 2023 · 12 comments · Fixed by #9237
Assignees
Labels
enhancement Adding or requesting a new feature. good first issue Opportunity for newcoming contributors. hacktoberfest This is suitable for Hacktoberfest. Don’t try to spam. help wanted Extra attention is needed.
Milestone

Comments

@buhtz
Copy link

buhtz commented Apr 28, 2023

Describe the issue

When PullRequests (button "Push") not working there is a simple message that doesn't help anyone.

Could not push to remote branch on bitdemo/bit_demo.

I already tried

  • I've read and searched the documentation.
  • I've searched for similar issues in this repository.

Steps to reproduce the behavior

Push.

Expected behavior

Name the reason why the Push didn't work. What exactly is missing?
And maybe give a hint about how to solve the problem.

If you link to the docu please make sure the docu really helps. It often does not. I read all the GitHub pullrequest setup stuff. I don't get it. What is missing in the docu is use-case orientated stuff. Describe use cases with a step by step tutorial. And also keep in mind that your users often do not know how weblate internally works. The same with git.
Take your users by the hand.

Screenshots

image

Exception traceback

No response

How do you run Weblate?

Other

Weblate versions

No response

Weblate deploy checks

No response

Additional context

No response

@buhtz
Copy link
Author

buhtz commented Apr 28, 2023

#8535

@nijel
Copy link
Member

nijel commented Apr 28, 2023

The detailed error message is stored in the history, but it makes sense to show it in the error message as well.

@nijel nijel added enhancement Adding or requesting a new feature. hacktoberfest This is suitable for Hacktoberfest. Don’t try to spam. help wanted Extra attention is needed. good first issue Opportunity for newcoming contributors. labels Apr 28, 2023
@github-actions
Copy link

This issue seems to be a good fit for newbie contributors. You are welcome to contribute to Weblate! Don't hesitate to ask any questions you would have while implementing this.

You can learn about how to get started in our contributors documentation.

@buhtz
Copy link
Author

buhtz commented Apr 28, 2023

Turn off the damn bot. Things like this do drive potential contributors away.

@buhtz
Copy link
Author

buhtz commented Apr 28, 2023

The detailed error message is stored in the history, but it makes sense to show it in the error message as well.

Where can I find the "History"? Maybe linking to that history in that error message would be helpful.

You mean this?
image

The message doesn't help me. The error was about a PullRequest. So why is there the need of a fork?

@nijel
Copy link
Member

nijel commented Apr 28, 2023

To submit a pull request, Weblate needs to push changes somewhere. Depending on a configuration, it will push to a branch or fork the repo, see https://docs.weblate.org/en/latest/admin/continuous.html#pushing-changes-from-weblate

@nijel
Copy link
Member

nijel commented Apr 28, 2023

And, yes, Gitea didn't provide an error message after calling API, so it's hard to guess what is wrong (still, it might be a bug in Weblate, but it's hard to tell without any additional information).

@buhtz
Copy link
Author

buhtz commented Apr 28, 2023

To submit a pull request, Weblate needs to push changes somewhere. Depending on a configuration, it will push to a branch or fork the repo, see https://docs.weblate.org/en/latest/admin/continuous.html#pushing-changes-from-weblate

I still don't understand the "fork". A fork is not a "git" operation. You mean "git clone"? But what is the source and what the destination of that clone? How does this help to get commits from a internal-weblate-git-repo into a codehosters git repo?

@nijel
Copy link
Member

nijel commented May 15, 2023

You typically fork a repository to create a pull request, see https://docs.gitea.io/en-us/usage/pull-request/

@buhtz
Copy link
Author

buhtz commented May 15, 2023

You typically fork a repository to create a pull request, see https://docs.gitea.io/en-us/usage/pull-request/

You reference inplicite knowledge here. That is one of the big problems of Weblate UI and its docu. Not all your users are nerds and hackers. And not all of them are dump or script kidies. But you need to find a way to better connect to your users. I don't open such issues just to ask things. I'm really interested in improving Weblate. I do contribute that way. Currently you definitely don't "connect to your users" and everyone knows and talk about how "problematic" the Weblate documentation and its GUI is.

I know what a "fork" is. But it is inconsistent in your UI. A "fork" is a marketing worked used (and maybe invented) by GitHub (now owned by Microsoft). Technically a fork is not a git operation but a "git clone" is. Then name it that way.

The term "fork" has a meaning in none technical area where one project is "duplicated" to go it's own way of development and evolution. For example Gitea is forked to Forge. Raiders now is known as Twix. 😄 A fork is an act of politics.

It is not clear what this error message is about and what Weblate tries to do here. Does it "git clone"? Be transparent about that.

@nijel nijel self-assigned this May 15, 2023
@nijel nijel added this to the 4.18 milestone May 15, 2023
nijel added a commit to nijel/weblate that referenced this issue May 15, 2023
nijel added a commit to nijel/weblate that referenced this issue May 15, 2023
nijel added a commit to nijel/weblate that referenced this issue May 15, 2023
- consolidate different errors from different VCS backends
- do not include trailing : if no detailed message is available

Issue WeblateOrg#9177
@nijel
Copy link
Member

nijel commented May 15, 2023

Weblate follows the terminology used by the code hosting service. So if Gitea calls that "Fork" and "Pull request" we use that name. GitLab, for example, uses "Merge request" instead, and we follow that as well.

You reference inplicite knowledge here.

If you want to integrate two services together, you need to understand both of them. Or read documentation for both of them.

everyone knows and talk about how "problematic" the Weblate documentation and its GUI is.

We're continually improving, and we welcome contributions to improve.

Technically a fork is not a git operation but a "git clone" is.

Technically, a fork is an API call to the code hosting site. It does not involve Git at all on Weblate side.

what Weblate tries to do here.

It tried to fork the repository using https://try.gitea.io/api/swagger#/repository/createFork and that failed without an error message. Unfortunately, Weblate has no knowledge at that point why Gitea API call has failed.

Anyway, the error message will be improved with #9237 and #9239. If you have any other ideas on how to improve Weblate, please submit a separate issues for these.

nijel added a commit to nijel/weblate that referenced this issue May 15, 2023
- consolidate different errors from different VCS backends
- do not include trailing : if no detailed message is available

Issue WeblateOrg#9177
nijel added a commit to nijel/weblate that referenced this issue May 15, 2023
nijel added a commit that referenced this issue May 15, 2023
@github-actions
Copy link

Thank you for your report; the issue you have reported has just been fixed.

  • In case you see a problem with the fix, please comment on this issue.
  • In case you see a similar problem, please open a separate issue.
  • If you are happy with the outcome, don’t hesitate to support Weblate by making a donation.

nijel added a commit to nijel/weblate that referenced this issue May 16, 2023
- consolidate different errors from different VCS backends
- do not include trailing : if no detailed message is available

Issue WeblateOrg#9177
nijel added a commit that referenced this issue May 16, 2023
- consolidate different errors from different VCS backends
- do not include trailing : if no detailed message is available

Issue #9177
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Adding or requesting a new feature. good first issue Opportunity for newcoming contributors. hacktoberfest This is suitable for Hacktoberfest. Don’t try to spam. help wanted Extra attention is needed.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants