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

Improve docu about "Fetching updated translations from Weblate" #9189

Closed
2 tasks done
buhtz opened this issue May 1, 2023 · 7 comments
Closed
2 tasks done

Improve docu about "Fetching updated translations from Weblate" #9189

buhtz opened this issue May 1, 2023 · 7 comments
Labels
documentation Improvements or additions to the documentation. 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 May 1, 2023

Describe the issue

This is about

https://docs.weblate.org/en/latest/devel/integration.html#fetching-updated-translations-from-weblate

The text doesn't help.

  • Explain the term "underlying Git repository" and give the correct URL for it.
  • Remove the misleading paragraph beginning with "This can be automated..." because the whole section is about "manual fetching" and not about "automation".

I already tried

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

Steps to reproduce the behavior

see above

Expected behavior

No response

Screenshots

No response

Exception traceback

No response

How do you run Weblate?

Other

Weblate versions

No response

Weblate deploy checks

No response

Additional context

No response

@nijel nijel added documentation Improvements or additions to the documentation. 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 May 2, 2023
@github-actions
Copy link

github-actions bot commented May 2, 2023

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 May 2, 2023

I beg for the possibility to block that damn @github-actions fake user.

@comradekingu
Copy link
Contributor

"Underlying …" could link to https://docs.weblate.org/en/latest/admin/continuous.html ?
Where does the confusion about automation arise?
It tries to help by stating it can be automated, but isn't clear that the steps are otherwise manual?

"VCS" should also be a link.
It is possible to help fix issues by submitting a PR :)

@buhtz
Copy link
Author

buhtz commented May 13, 2023

"Underlying …" could link to https://docs.weblate.org/en/latest/admin/continuous.html ?

That link is interesting. Point 2 the most. How can I automate point 2? Can I somehow with weblate?
Following the link in point 2 just brings to to an explanation that I have to do this manually.

What I'm talking about is calls to xgettext ans msgmerge and things like that. Can Weblate do this for me?

@nijel
Copy link
Member

nijel commented May 15, 2023

The problem is that you typically do not just run xgettext and msgmerge, but it's wrapped by some other tooling (intltool, Django's makemessages, or completely custom solutions). So, this ends up being a generic service for executing untrusted code. There are a bunch of existing CI services available, which have already developed a way of doing that securely. Presently, this is out of scope for Weblate.

PS: There is msgmerge add-on in Weblate.

@buhtz
Copy link
Author

buhtz commented May 15, 2023

I think we still talk around each other. 😄 But this issue isn't about if and how to automate that step.
It is about being clear about it in the docu.

The docu tells me it is automatable.
But behind the link there is no docu about automation but about manual steps.
The docu is full of misleading information's about that topic.

And I don't see a difference between calling xgettext/msgmerg or any other tool. And I couldn't find a docu about initl or a tutorial that explain me why it is better or more efficient than using xgettext/msgmerge.

You tell that it is out of scope of weblate. OK to me. But be clear about it in the docu and don't mislead your readers/users. That is what this issue is about. Improve your docu.

If you agree keep the issue open until it is fixed.
If you don't, close it.

@nijel nijel closed this as completed in e0cd401 May 19, 2023
nijel added a commit that referenced this issue May 19, 2023
@nijel nijel added this to the 4.18 milestone May 19, 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 that referenced this issue Oct 13, 2023
This is pretty much what I have written before in #9189.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to the documentation. 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

No branches or pull requests

3 participants